我正在将 doxygen 文档从 Visual Studio C# 项目移植到 Java Eclipse 项目。您能否建议将一种风格的评论映射到另一种风格的教程或一些指南？
例如，如何将这个 doxygen 注释翻译成 javadoc 注释？
/// 自定义解决方案数据类型，派生自解决方案
谢谢
问问题
459 次
1 回答
2
从尝试从 doxygen（C 语言）映射到 javadoc 的人的角度来看，我认为您会发现这个方向非常困难，特别是如果您在原始评论中有很多叙述的话。我发现 javadoc 严重缺乏 doxygen 的大部分功能，所以实际上只有绝对最低限度的评论可以有用地转移——比如@param、@return 等。我从来没有找到任何好的教程，甚至没有找到任何不好的教程。我怀疑这不是人们自愿做的事情。
考虑是否可以继续使用 doxygen。Doxygen 解释了所有的 javadoc 命令（至少是我遇到的所有命令），并且您可以良性地将 doxygen '\' 样式的命令添加到 java 注释中，而不会破坏任何现有的 javadoc 处理。
编辑：只是为了稍微澄清这一点。由于使用 \command 条目，Javadoc 不会出现警告或错误，但 \command 文本将作为文本出现在 javadoc 输出中。
当然，缺点是如果您想在 IDE（例如 Eclipse）中弹出窗口，则需要javadoc ，因此如果这是必需的，那么使用 doxygen 将没有多大用处。但是，如果您只需要创建带有图表和叙述的高质量 HTML 文档/手册，那么它可能是一种选择。
于 2013-07-24T13:09:08.363 回答