Doxygen解析javadoc?(Doxygen parse javadoc?)
我很好奇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风格?
I'm curious as to if Doxygen parses Javadoc comments? - that is, does doxygen accept something alike this:
/** 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; }And another thing, is there a more correct way of doing these comments, doxygen style?
最满意答案
Doxygen接受与JavaDoc类似的语法,但不完全相同。 除了@ret命令之外,您的示例注释将被识别。 doxygen中的正确命令是@return 。
以下是doxygen网站上的示例:
http://www.stack.nl/~dimitri/doxygen/docblocks.html
Doxygen accepts similar syntax to JavaDoc, but not exactly the same. Your example comment would be recognized, except for the @ret command. The correct command in doxygen is @return.
Here are the examples on doxygen's website:
http://www.doxygen.nl/manual/docblocks.html
更多推荐
发布评论