xxxreport工具从Python源代码中提取所有TODO/XXX注释
项目描述
xxxreport
xxxreport 是一个工具,可以从Python源代码中提取所有TODO/XXX注释以生成一个纯文本或HTML摘要文档。
xxxreport 受到Zope xxxreport工具 (http://svn.zope.org/Zope3/trunk/utilities/) 的启发。
如何使用
$ easy_install xxxreport
提取注释
$ xxxreport --title=WsgiDAV ~/my_python_projects/ =================================== TODO/XXX Comment report for WsgiDAV =================================== Generated on Sun, 01 Nov 2009 19:27:33 CET Summary ======= There are currently 3 TODO/XXX comments. Listing ======= File : wsgidav/addons/virtual_dav_provider.py:220 # TODO: this is just for demonstration: self.resourceData = _resourceData File : wsgidav/addons/virtual_dav_provider.py:350 # dict["etag"] = util.getETag(file path), # TODO: should be using the file path here dict["contentType"] = res.getContentType() dict["contentLength"] = res.getContentLength() dict["supportRanges"] = True File : wsgidav/addons/mysql_dav_provider.py:335 # TODO: calling exists() makes directory browsing VERY slow. # At least compared to PyFileServer, which simply used string # functions to get displayType and displayRemarks if not self.exists(path):
更多信息
$ xxxreport --help
0.1.3 (2009-11-06)
功能
添加 --file-extension 选项
添加 --marker-prefix 选项