best way to comment

closed account (Dy7SLyTq)
so im not talking about commenting the code, i can do that fine. im talking about the part at the beginning. ive seen the gpl. ive personally done the authors version info and a little bit about the program, but is there a better way?
Lulwut?
closed account (Dy7SLyTq)
like this
http://www.8325.org/sudoku/solver.cc
How about you use Doxygen? You'll need to write special comments for that, like:
1
2
3
/// @brief Short program.
/// @authors Me and ½ of my friends.
/// @copyright Evil License. 


Doxygen utility download here:
http://www.stack.nl/~dimitri/doxygen/

Actual usage example here:
http://cplusplus.com/articles/iL18T05o/lzw_v1.zip
closed account (Dy7SLyTq)
ok yeah ill use that thank you
I recommend you use Doxygen comments in header files only. In source files, keep comments to a bare minimum.
closed account (Dy7SLyTq)
why is that?
Well, I used to put Doxygen comments in source files and header files, which meant if I updated one I had to make sure to update the other. Too many comments also gets in the way and makes the code hard to read.
Topic archived. No new replies allowed.