用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类型，如string，int，list，......？

Answer 1

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