Doxygen是否能解析JavaDoc?

5

我想知道Doxygen是否解析Javadoc注释?也就是说,Doxygen是否接受类似于这样的内容:

/**
   Greet with a "Hello" message.
   @param a string containing the name of the person or entity
   @ret return a string containing "Hello" and the name of the greeted person or entity.
*/
public String sayHello(string name)
{
   return "Hello" + name;
}

另外,有没有更正确的方法来编写这些注释,比如doxygen风格?

1个回答

7

Doxygen接受类似于JavaDoc的语法,但并非完全相同。您的示例注释将被识别,除了@ret命令。在doxygen中正确的命令是@return

以下是doxygen网站上的示例:

http://www.doxygen.nl/manual/docblocks.html


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接