Doxygen解析javadoc?

问题描述 投票:3回答:1

我很好奇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风格?

documentation javadoc doxygen documentation-generation
1个回答
5
投票

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

以下是doxygen网站上的示例:

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

© www.soinside.com 2019 - 2024. All rights reserved.