草庐IT

undocumented

全部标签

ruby - 如何使用 yardoc 列出未记录的模块/类/常量/方法?

我有一个小型代码库,我正在用YARD记录这些代码.当我运行yardoc命令时,它告诉我:Files:40Modules:14(0undocumented)Classes:39(0undocumented)Constants:21(4undocumented)Methods:239(31undocumented)88.82%documented与其费力地遍历我的所有代码来查找未记录的常量和方法,我希望它简单地列出未记录的项目。有人知道怎么做吗? 最佳答案 您可以使用--list-undoc选项专门列出所有未记录的对象(及其文件位置)。

python - Sphinx autodoc show-inheritance : How to skip undocumented, 中间基础?

我有一个像这样的三层类结构:classSuper(object):"""Thisclassisdocumented."""classIntermediate(Super):passclassSub(Intermediate):"""Thisisalsodocumented."""我的index.rst文件如下所示:..automodule::mymodule:show-inheritance::inherited-members:Sphinx为我生成了一份不错的API文档。它包括类Super和Sub,并带有适当的注释。它不包括Intermediate,因为它没有注释而且我没有提供und