Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What markup format does the VS Code C++ (Cpptools) extension support for rendering definition preview hovers?

Tags:

c++

vs-code

I have seen this doc formatting comment in a library I added to one of my workspaces, and I see it uses something close to doxygen, and it works great off the shelf with VS code, I didn't install doxygen or any other doc generator plug in

  /**********************************************************************/
  /*!
    @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);

It works super well and generates nice doc when dragging over the function

enter image description here

Can someone point me to what is this doc and where I can find it's syntax documentation / arguments to learn to use it?

like image 352
JCSB Avatar asked Sep 03 '26 21:09

JCSB


1 Answers

Visual Studio and Visual Studio Code recognize Doxygen comment formatting.

/**, /*! as well as ///-style comments are supported.

There are also extensions that can generate doxygen comments.

like image 176
rustyx Avatar answered Sep 06 '26 09:09

rustyx



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!