在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
Run Code Online (Sandbox Code Playgroud)
将字符串添加到文档中my_variable.在Python中尝试等效的东西似乎不起作用.这有效:
## This is my variable
my_variable = None
Run Code Online (Sandbox Code Playgroud)
这个:
my_variable = None ## This is my variable
my_other_variable = None
Run Code Online (Sandbox Code Playgroud)
my_other_variable正如您所期望的那样,附上文档,但这两者都是:
my_variable = None ##< This is my variable
my_variable = None #!< This is my variable
Run Code Online (Sandbox Code Playgroud)
似乎只是放弃了文档.有没有办法//!<在Python中做相同的操作?
不,目前这不受支持.
Python的解析器由几个学生提供.虽然他们总体上做得很好,但他们没有实现可用于C/C++的所有功能.
缺少的两个最值得注意的功能是:
希望我能在将来添加这些内容,但欢迎任何帮助.