一个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使用spring并在CXF中生成服务器和客户端   重载是否可以重载抽象Java类中的抽象方法,但只实现子类中的一个重载方法?   javawhy系统。currentTimeMillis()是否生成不正确的长值?   java使用Apache POI API将xlsx转换为csv   资源Java找不到文件?   java APDU命令验证返回6a88   JAVAlang.ExceptionInInitializerError是在交换机中构造对象时创建的   java使用嵌套while循环打印星形金字塔   sql Java ResultSet获取返回的字段名   java无法将字符串更改为整数,因为负号跟在数字后面   为什么番石榴/爪哇使用“可能”。isPresent()与可选项相反。是否显示(可能)?   JavaJUnit4看不到bean   JavaJBoss以错误的顺序启动servlet   java无法下载Maven依赖项AnypointStudio   安卓如何在java中存储持久数据   java SQL Server JDBC的驱动程序类名是什么   java中针对大输入的性能优化BufferedReader   java eclipse自动完成内容助理