有没有一种简单的方法来计算库中记录的函数

Is there a simple way to count documented functions in a library?

本文关键字：计算函数记录方法有没有一种简单更新时间：2023-10-16

有没有一种简单的方法来计算库中有多少函数、方法和/或类？有多少被记录在案？也许通过氧气输出？

当我尝试谷歌解决方案时，我得到的只是计算事物的算法...... :)

有一个名为 Coverxygen 的工具，它需要来自 Doxygen 的 XML 输出。

通过以下方式安装它：

pip install coverxygen

奖金：如果您使用 Sphinx 和 Doxygen(和 Breathe(生成文档，您可以使用 DocsCov 制作一个徽章，显示文档覆盖范围以显示在您的自述文件中。

正如黄欣在上面的评论中指出的那样，有一个有用的工具叫做doxy-coverage.py at https://github.com/alobbs/doxy-coverage。对于使用 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))

添加项目中的实体总数

和记录的实体总数。

似乎可以修改该工具以按类型区分实体。如果我这样做，我将在此处发布生成的代码。