python - 当使用 doxygen 记录 Python 代码时，你应该记录 self 参数吗？

Question

我有一些用 doxygen 记录的 Python 代码，我想知道记录方法的 self 参数是否正常？

示例:

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

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

如何记录参数类型，如字符串、整数、列表……？

Answer 1

我不知道什么是常见做法，但我不会这样做。它只会给文档增加困惑，因为它的用法是显而易见的。文档中的困惑是不好的，因为它掩盖了您真正想看到的内容。