Texonom
Texonom
/
Engineering
Engineering
/Software Engineering/Programming/Programming Language/Programming Languages/4GL/C++/CPP Convention/
cpp documentation convention
Search

cpp documentation convention

Creator
Creator
Seonglae ChoSeonglae Cho
Created
Created
2020 Jun 16 4:42
Editor
Editor
Seonglae ChoSeonglae Cho
Edited
Edited
2023 Apr 12 4:15
Refs
Refs
 
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".
Best practice for C++ function commenting
https://stackoverflow.com/questions/2198241/best-practice-for-c-function-commenting
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.
Recommended Tags for Documentation Comments (C++ documentation comments)
https://docs.microsoft.com/en-us/cpp/build/reference/recommended-tags-for-documentation-comments-visual-cpp?redirectedfrom=MSDN&view=vs-2019
 
 
 
 

Recommendations

Texonom
Texonom
/
Engineering
Engineering
/Software Engineering/Programming/Programming Language/Programming Languages/4GL/C++/CPP Convention/
cpp documentation convention
Copyright Seonglae Cho