一个gotcha关键字分析器

gotcha的Python项目详细描述


#gotcha是一个python2程序,它解析源代码以提取开发人员的评论。这些注释以一种称为gotcha keywords的特殊格式编写,它们用于以一种正式的方式指出代码中的错误、可能重写的代码部分、文档……任何对开发人员有用的信息。

一眨眼就能看到剩余的工作量。事实上,当我们使用gotcha来显示“todo”注释时,我们可以看到为了在项目中取得进展而必须完成的任务。搜索关键字“bug”会列出需要调试的部分代码,而“棘手的”注释则用于解释仅通过阅读可能难以理解的部分代码。

\comments format
comment gotcha必须这样写:
cs:keyword:dev name:yyyymmdd:comment

“cs”代表comment符号。关键字必须大写。日期必须遵循yyyymmdd格式。

c注释示例:
//:todo:meow:20121221:找到一种生存到世界末日的方法

gotcha能够解析,其意义是:

*bug:描述代码中的一个bug,如果可能的话,在下一行进行简要描述
*debug:表示开发人员正在处理此注释之前描述的bug不安全…
*to do:描述要执行的任务
*kludge:描述在发布之前必须重写的代码(快速和脏代码)
*技巧:用于解释某些技术代码,仅通过阅读难以理解。
*doc:文档代码的描述
*注释:一个“经典”注释,在发布后可能会保留下来

这些关键字按类排序,下面是定义:

*关键:描述关键信息,必须尽快完成的工作。
*重要信息:重要信息,一些任务
*信息:必须保留在文档中的信息注释
*注意:注释、注释,…

使用-h显示所有可用选项。

gotcha可以显示所有gotcha关键字,而且还可以显示所需的信息。我们可以指定要解析的文件,忽略,告诉他解析每个子目录中的每个文件,仅在当前目录中。可以按关键字类筛选结果,忽略某些关键字,只显示要查看的关键字。最后,我们还可以按关键字、开发人员姓名和日期对结果进行排序。我们可以显示适合自己需要的信息。

有关更多信息,我建议您使用-h选项启动程序。您将看到所有选项和一些使用示例。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java WebClient请求级别超时抛出名为default onErrorDropped的运算符   java JAXB外部绑定文件错误   Freemarker中的java转义宏参数值   java正在同步来自不同对象{已编辑}的线程   java如何在另一个类上更新活动中的元素   java Hibernate连接查询   java可以使用Apache Crunch创建类似于图形的数据结构吗?   java在JLabel的开头加上3个点   java 安卓应用程序显示线程错误   java@RequestBody在Spring中总是空的   java Android异步任务永远不会结束   具有多个属性的java Jaxws枚举   java中的安卓 Stripe InvalidRequestException   多线程java。util。非多线程程序中的ConcurrentModificationException   Minecraft Java插件如何删除HashMap中存储的所有块   空Java字符串的大小   从AJP连接器请求检索Shibboleth属性的java   oracle11g将Java类文件加载到Oracle数据库