什么是 VS 代码的默认文档格式

时间:2021-03-04 15:44:05

标签: c++ visual-studio-code

我在我添加到我的工作区之一的库中看到了这个文档格式注释,我看到它使用了接近于 doxygen 的东西,并且它在现成的 VS 代码中运行良好,我没有安装 doxygen 或任何其他文档生成器插件

  /**********************************************************************/
  /*!
    @brief  Apply the bracket's calibration curve to get a load in N from signal in mV
    @param  mV_reading    The loadcell's input signal in mV
  */
  /**********************************************************************/
    float _getTorqueNmFromBracketCurve(float mV_reading);

它工作得非常好,并且在拖动函数时生成漂亮的文档

enter image description here

有人可以告诉我这个文档是什么以及在哪里可以找到它的语法文档/参数来学习使用它吗?

谢谢!

1 个答案:

答案 0 :(得分:1)

Visual StudioVisual Studio Code 识别 Doxygen 注释格式。

支持

/**/*! 以及 /// 样式的注释。

还有一些扩展可以generate doxygen 评论。