我正在将visual studio c#项目中的doxygen文档移植到java eclipse项目中。 您能否建议一些教程或一些指南来映射一种评论方式 对方?
例如,如何将此doxygen注释翻译为javadoc注释?
///自定义解决方案数据类型,派生自解决方案
由于
答案 0 :(得分:2)
从一个试图从doxygen(在C中)映射到javadoc的人的角度来看,我认为你会发现这个方向非常困难,特别是如果你在原始评论中有很多叙述。我发现javadoc在doxygen的大部分功能方面都非常缺乏,所以真的只有绝对最小的评论可以有用地转移 - 像@ param,@ return等。我从来没有找到任何好的教程,甚至任何不好的教程。我怀疑这不是人们可以选择做的事情。
考虑是否可以继续使用doxygen。 Doxygen解释了所有的javadoc命令(至少是我遇到过的所有命令),你可以将doxygen'\' - style命令添加到java注释中,而不会破坏任何现有的javadoc处理。
编辑:只是为了澄清这一点。由于使用\ command条目,Javadoc不会出现警告或错误,但\ command文件将作为文本出现在javadoc输出中。
当然,缺点是如果你想在你的IDE(例如Eclipse)中弹出窗口需要 javadoc ,所以如果这是一个要求,那么使用doxygen将没有多大用处。但是,如果您只需要使用图表和叙述创建高质量的HTML文档/手册,那么它可能是一种选择。