Doxygen 对 Python 中声明的行尾注释

Question

在 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 中做相当于//!<的方法？

Answer 1

不，目前不支持此功能。

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

缺少的两个最显着的功能是：

• 支持在定义之后记录东西
  https://bugzilla.gnome.org/show_bug.cgi?id=361813
• 支持交叉引用和调用图
  http://old.nabble.com/Python-callgraph-td24224054.html

希望我将来可以添加这些，但欢迎提供任何帮助。