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

希望我能在未来添加这些功能，但任何帮助都是受欢迎的。