Question

我如何在doxygen中记录if语句，它记录了我的所有类，函数，但是我为其写的注释，如果是法则，它会考虑下一个最接近的变量。

if abc != "":  # Here we check if abc is not equal to null and then check if it is equal to some known values
    if abc != "red":
        if abc != "blue":
            error()

if gfh != ""
    ghf = 0

它将评论分配给＆＃34; ghf = 0＆＃34; ，任何想法如何将评论分配给if语句。

Answer 1

Doxygen是生成API文档的工具。也就是说，有关将客户端代码编写者作为目标受众的功能和用法的文档。这些自然不关心实施细节。

您的目的是为代码的维护者添加文档。这是另一回事，Doxygen没有解决这个问题。

除了一些代码可读性的一般经验法则之外，我不知道是否有工具可以帮助您记录控制流程：

避免＆＃34;意大利面条代码＆＃34;
赋予变量/函数有意义的名称
写有意义的文档字符串

例如，您可以引入一个执行检查的函数，并相应地返回一个布尔值。这纯粹通过使用标准语言功能提高了可读性。

# you don't even need a comment to find out what the intention is here
if is_invalid(abc):
    error()

另请查看this post，也许IPython Notebook可能值得一试。

在doxygen中记录if语句

1 个答案: