当用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

我不知道什么是常见的做法，但我不会去做。它只是增加了文档的混乱，因为它的用法很明显。在文档中出现混乱是不好的，它会掩盖你真正想看到的东西。