在doxygen中記錄if語句

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

它將注釋分配給“ghf = 0”，任何想法如何將注釋分配給if語句。

Answer 1

Doxygen是生成API文檔的工具。 也就是說，有關將客戶端代碼編寫者作為目標受眾的功能和用法的文檔。 這些自然不關心實現細節。

您似乎要做的是為代碼的維護者添加文檔。 這是另一回事，Doxygen沒有解決這個問題。

我不知道是否有工具可以幫助您記錄控制流程，除了一些通用的代碼可讀性規則：

• 避免“意大利面條代碼”
• 給變量/函數有意義的名字
• 寫有意義的文檔字符串

例如，您可以引入一個執行檢查的函數，並相應地返回一個布爾值。 這純粹通過使用標准語言功能提高了可讀性。

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

另外看看這篇文章 ，也許IPython Notebook可能值得一試。