Quote:
|
I noticed that we have different comments format. I think we have to use single format. As for me, the format "//!" is ok.
|
That's not "my" format, but I follow the syntax given by Doxygen.
Doxygen let's us steer the documentation, that it generates from the .h-file.
We can define groups, comment functions and their parameters and return values and a lot of more things.
For this Doxygen requires a certain way of commenting. I looked some techniques up in the Doxygen manual and used it this way.
If our aim is to have a Doxygen-generated html-documentation, we have to stick to Doxygen's syntax.
But you could suggest, which set of doxygen comments we should use and which one we should avoid, to get a homogen and smooth documentation-style.
by the way:
shouldn't it read "\brief" and not "\breaf" ?