Coding and Documentation Standards

Commenting Standards

Our approach will be to produce comments for use by Doxygen in .h files and duplicate those comments in the corresponding .cpp files. This is for convenience of human readers/programmers. To prevent Doxygen from being confused (duplicating entries), comments in the .cpp files should start with "/*" or "//", rather than "/**" or "//!", so Doxygen will ignore those comments -- the .h file comments will be the canonical ones for that purpose.