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 要求你在实际的文档之前，先说明一下会抛出哪些异常。

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

希望这对你有帮助。