在使用doxygen编写Python代码文档时,是否应该编写self参数文档?
我有一些用doxygen记录的Python代码,我想知道记录方法的自参数是否正常 例如:在使用doxygen编写Python代码文档时,是否应该编写self参数文档?,python,doxygen,Python,Doxygen,我有一些用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 m
## @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等?我不知道常用的做法是什么,但我不会这么做。它只是给文档增加了混乱,因为它的用法是显而易见的。文档中的杂乱是不好的,因为它掩盖了你真正想看的东西