在doxygen中記錄if語句

Question

我如何記錄doxygen中的if語句，它記錄我所有的類，fucntions，但是我寫的註釋如果是statings，它會考慮下一個最近的變量。

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() 

也看看this post，也許還IPython Notebook可能是一個值得一試。