python - Python 中声明的 Doxygen 行尾注释

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

希望我能抽空在将来添加这些，但欢迎任何帮助。