Doxygen对Python中声明的注释结束

时间:2011-05-30 17:47:32

标签: python doxygen

在C / C ++中,您可以强制doxygen识别注释是否适用于行前面的文本。其中任何一个:

int my_variable;                 /*!< This is my variable */
int my_variable;                 /**< This is my variable */
int my_variable;                 //!< This is my variable
int my_variable;                 ///< This is my variable

将字符串添加到my_variable的文档中。在Python中尝试等效的东西似乎不起作用。这有效:

## This is my variable
my_variable = None

此:

my_variable = None               ## This is my variable
my_other_variable = None

将文档附加到my_other_variable,正如您所期望的那样,但这两者都是:

my_variable = None               ##< This is my variable
my_variable = None               #!< This is my variable

似乎只是放弃了文档。有没有办法在Python中执行等效的//!<

1 个答案:

答案 0 :(得分:8)

不,目前不支持。

Python的解析器由几个学生提供。虽然他们总体上做得很好,但他们没有实现可用于C / C ++的所有功能。

缺少的两个最值得注意的功能是:

希望我将来能够添加这些内容,但欢迎任何帮助。