有没有一种简单的方法来计算库中记录的函数?
Is there a simple way to count documented functions in a library?
有没有一种简单的方法可以计算一个库中有多少函数、方法and/or 类?记录了多少?也许通过 Doxygen 输出?
当我尝试 Google 一个解决方案时,我得到的只是计算事物的算法...:)
正如 Xin Huang 在上面的评论中指出的,在 https://github.com/alobbs/doxy-coverage 有一个名为 doxy-coverage.py
的有用工具。对于用 Doxygen 记录的每个文件,它打印它有多少实体(命名空间、自由函数、类、成员函数、枚举、#defines 等)以及其中有多少被记录。它列出了每个未记录的实体。在底部,它给出了文档覆盖率的摘要(记录的实体百分比)。它使用 Doxygen 的 XML 输出来做到这一点。
我换了行
print("%d%% API documentation coverage" %(total_per))
来自
print ('%3d%% API documentation coverage (%d of %d)'%(total_per, total_yes, total_all))
添加项目中的实体总数和记录的实体总数。
似乎可以修改工具以按类型区分实体。如果我这样做,我将 post 生成的代码放在这里。
有一个名为 Coverxygen 的工具需要从 Doxygen 输出 XML。
通过以下方式安装:
pip install coverxygen
奖金:
如果您使用 Sphinx 和 Doxygen(以及 Breathe)来生成文档,您可以使用 DocsCov 制作一个徽章来显示文档覆盖率以显示在您的自述文件中。
有没有一种简单的方法可以计算一个库中有多少函数、方法and/or 类?记录了多少?也许通过 Doxygen 输出?
当我尝试 Google 一个解决方案时,我得到的只是计算事物的算法...:)
正如 Xin Huang 在上面的评论中指出的,在 https://github.com/alobbs/doxy-coverage 有一个名为 doxy-coverage.py
的有用工具。对于用 Doxygen 记录的每个文件,它打印它有多少实体(命名空间、自由函数、类、成员函数、枚举、#defines 等)以及其中有多少被记录。它列出了每个未记录的实体。在底部,它给出了文档覆盖率的摘要(记录的实体百分比)。它使用 Doxygen 的 XML 输出来做到这一点。
我换了行
print("%d%% API documentation coverage" %(total_per))
来自
print ('%3d%% API documentation coverage (%d of %d)'%(total_per, total_yes, total_all))
添加项目中的实体总数和记录的实体总数。
似乎可以修改工具以按类型区分实体。如果我这样做,我将 post 生成的代码放在这里。
有一个名为 Coverxygen 的工具需要从 Doxygen 输出 XML。
通过以下方式安装:
pip install coverxygen
奖金: 如果您使用 Sphinx 和 Doxygen(以及 Breathe)来生成文档,您可以使用 DocsCov 制作一个徽章来显示文档覆盖率以显示在您的自述文件中。