cpp documentation convention


/*
<summary>cpp call from node main cpp file</summary>
<param name="sel">Column to be sorted (index-1-based) and sort direction (pos. = ascending)</param>  
<returns>Documentation of return type</returns>
*/

Best practice for C++ function commenting

Asked Is there an accepted best practice for commenting functions? I only know of the doxygen style but it is not officially supported by C++ like Javadocs is for Java so just wondering what is best. There only general thing most people will agree with is that comments should say "why", not "what".

https://stackoverflow.com/questions/2198241/best-practice-for-c-function-commenting

Recommended Tags for Documentation Comments (C++ documentation comments)

The MSVC compiler will process documentation comments in your code and creates an .xdc file for each compiland, and xdcmake.exe will process the .xdc files to an .xml file. Processing the .xml file to create documentation is a detail that needs to be implemented at your site.

https://docs.microsoft.com/en-us/cpp/build/reference/recommended-tags-for-documentation-comments-visual-cpp?redirectedfrom=MSDN&view=vs-2019

cpp documentation convention

Recommendations