當用doxygen記錄Python代碼時，你應該記錄自我參數？

Question

我有一些與doxygen記錄的Python代碼，我想知道如果這是正常的文件自我參數的方法？

例子：

## @par Description: 
# Some desc 
# @note 
#  
# @param something @e string: a string 
#  
# @return @b Boolean: True if ... 
# 
# @b Example: 
# @code 
# 
# instance.myMethod("some") 
# 
# @endcode 
def myMethod(self, something): 
    return True 

什麼是該方法的正確Doxygen文檔？

我是否必須對自我參數做一些特別的事情？

如何記錄下parmeter類型，如字符串，整數，列表，...？

Answer 1

我不知道什麼是常見的做法，但我不會去做。它只是增加了文檔的混亂，因爲它的用法很明顯。在文檔中出現混亂是不好的，它會掩蓋你真正想看到的東西。