Doxygen 解析 javadoc?

发布于 2024-10-11 14:13:40 字数 388 浏览 8 评论 0原文

我很好奇 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 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

旧人九事 2024-10-18 14:13:40

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

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文