在用doxygen编写Python代码时，是否应该记录self参数？

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文档是什么？在

我需要对自参数做一些特别的事情吗？在

如何记录参数类型，比如string、int、list等等。。。？在

Answer 1

我不知道什么是惯例，但我不会这么做。它只是给文档增加了混乱，因为它的用法是显而易见的。文档中的混乱是不好的，因为它模糊了你真正想看的东西。在