我一直在使用doxygen生成文档输出的C ++项目。我们使用的文档方法如下所示:
//! This is an awesome method. You should totally use this method for all sorts
//! of cool stuff that you might want to do.
//! @returns something useful
string my_awesome_method() {...}
如您所见,我们使用//!
注释前缀来表示doxygen注释块。我们发现这非常适合我们的需求。
现在我们正在添加一个Java组件,并且希望保持与我们在C ++中使用的注释样式的一致性,而不是移动到我们认为是javadocs使用的笨拙的/** */
样式。有没有办法让javadocs识别像doxygen那样的其他前缀?或者javadocs是否需要使用/** */
?我们可以使用doxygen,但是围绕javadoc构建各种各样的细节,以便我们希望保持与该生态系统的接口。
这可能吗?我担心答案可能不是。 :(
答案 0 :(得分:1)
是的,/** */
是javadoc识别的唯一注释格式。请参阅http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format。