python - doxygen python引发异常

Question

我是使用 Doxygen 来记录我的 Python 代码的新手。我喜欢记录我的方法/函数引发的异常。我过去使用@raise 做过这个，但 Doxygen 似乎没有意识到这一点。我现在也尝试过@exception（javadoc/Doxygen 习惯用法），但这似乎也没有被 Doxygen 解析（@exception 或 @raise 行被传递到生成的 HTML，就好像它在代码/编码中一样堵塞）。

有什么方法可以说服 Doxygen（我使用的是 1.8.3）解析 Python 代码的 @exception 标签？

谢谢，

布赖恩

Answer 1

尝试使用 Doxygen 1.8.8 我使用@exception标签获得了不错的 Doxygen 输出。但是，Doxygen 要求您在实际文档之前指定抛出哪个异常。

 ##
 # @brief This is my function
 #
 # @exceptions MyException My function can throw a MyException
 #

我希望这有帮助。