Doxygen 解析 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?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(1)
Doxygen 接受与 JavaDoc 类似的语法,但并不完全相同。您的示例注释将被识别,但
@ret
命令除外。 doxygen 中正确的命令是@return
。以下是 doxygen 网站上的示例:
http://www.doxygen.nl/manual/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