我一直在使用 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,但是围绕 javadocs 构建了各种各样的细节,因此我们希望维护与这个生态系统的接口。
这可能吗?恐怕答案可能是否定的。:(