search

mattrussmill / qcvTouchUp

Simple image viewer and editor for photographs - OpenCV and Qt Widgets application
GNU General Public License v3.0
5 stars 1 forks source link

Standard comment header #28

Closed mattrussmill closed 5 years ago

mattrussmill commented 6 years ago

Come up with a standard comment header for functions and use it.

mattrussmill commented 6 years ago

Should comments also exist in header file? Comments include use case explanation in header (e.g. static and virtual)?

mattrussmill commented 6 years ago

Read these: http://www.edparrish.net/common/cppdoc.html https://google.github.io/styleguide/cppguide.html

mattrussmill commented 6 years ago

https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html

read all comments: https://stackoverflow.com/questions/355619/where-to-put-the-doxygen-comment-blocks-for-an-internal-library-in-h-or-in-cpp

"Having comments in the header means that all users of a class must be recompiled if a comment is changed. For a large projects, coders will be less inclined to update comments in headers if they risk spending the next 20min rebuilding everything.

And.. since you're supposed to read the html doc and not browse through the code for documentation, it's not a large problem that the comment blocks are more difficult to locate in the source files."

mattrussmill commented 5 years ago

don't bother with this project. current format is fine