C++(Visual Studio)有Java风格的注释吗?

Does C++ (Visual Studio) have Java style comments?

本文关键字:风格 注释 Java Visual Studio C++      更新时间:2023-10-16

当我们在 Java 中使用/** */注释样式时,它@param这些注释, 或@num1,这样可以更轻松地阅读注释,并消除可能出现的歧义。例如,如果你想在你的注释中引用num1,通过写@num1颜色变化,你知道注释引用参数num1,但如果你说num1,参数的颜色保持不变,很难阅读,可能会与另一个同名变量混淆。这只是一个例子。

爪哇风格:

/**
* @param num1
* @param num2
*/
public void sum(int num1, int num2) {
...
}

它与语言本身无关,但有一些文档生成程序确实可以理解"Javadoc"风格的注释。

例如Doxygen。

C++标准没有像Java对Javadocs那样定义任何注释语义。

但是,有一些扩展,如doxygen,cldoc或DOC++,它们提供类似的功能。

检查您的 IDE/文本编辑器是否支持 doxygen 语法突出显示。

C++没有为这些注释提供处理器,但它们确实存在。13年前我用过一个。我想它被称为...cppdoc,但不要引用我的话。