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

np8igboo  于 2022-11-19  发布在  其他
关注(0)|答案(2)|浏览(139)

我在我添加到我的一个工作区的库中看到了这个文档格式注解,我看到它使用了一些接近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);

它工作得非常好,当拖动函数时会生成很好的文档

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

unhi4e5o

unhi4e5o1#

Visual StudioVisual Studio程式码可辨识Doxygen注解格式。

支持/**/*!以及///样式的注解。
也有扩展可以generate doxygen注解。

taor4pac

taor4pac2#

VSCode只能剖析部分语法。
参考:MS C++团队的文章:C++ Team Blog - Visual Studio Code C++ Extension July 2020 Update: Doxygen comments and Logpoints

/// @brief Calculates the area of the triangle
/// @tparam T is the template param
/// @param base is the horizontal length
/// @param height is the vertical length
/// @return Area of triangle
/// @deprecated This is the deprecated comment
template<typename T>
T TriangleAream(T base, T height)
{
    double result;
    result = base * height * 0.5;
    return (T)result;
}

imgur - doxygen VSCode visual picture
VS C++团队可以做很多事情。
如:

相关问题