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
 #
 # @exception MyException My function can throw a MyException
 #

我希望这有帮助。