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

希望我將來可以添加這些，但歡迎提供任何幫助。