Doxygen解析javadoc?(Doxygen parse javadoc?)

编程入门 行业动态 更新时间:2024-10-19 04:23:17
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

更多推荐

本文发布于:2023-08-07 00:20:00,感谢您对本站的认可!
本文链接:https://www.elefans.com/category/jswz/34/1458868.html
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
本文标签:Doxygen   javadoc   parse

发布评论

评论列表 (有 0 条评论)
草根站长

>www.elefans.com

编程频道|电子爱好者 - 技术资讯及电子产品介绍!