examples of how to write beautiful c++ comments [closed]

Question

maybe is stupid question but is there any way to write good looking (short ) format to write comments for c++ function,headers,variable ? any visual examples?

Answer 1

What do you mean by good looking here ? I do it like this ..

int c;//! loop Counter

/**
 * compares (XOR) two Types
 * return boolean result
 */
bool compare(Type l, Type r);

Its doxygen format. there are populer formats for documenting codes in Comment. Doxygen is one and another one is naturaldocs. there are even more. Its your flavour. You may even like the naturaldocs format.

/*
   Function: Compare
   Compares two Types
   Parameters:
      l - lhs
      r - rhs.
   Returns:
      boolean result

*/
bool compare(Type l, Type r);

The DOC++ format is also similer like.

/** Comparison
    Compare two Types

    @param l Type lhs
    @param r Type rhs
    @return boolean result
*/
bool compare(Type l, Type r);

Just use only one format and stick with it.

Answer 2

I prefer using this style:

/**
 * Class name
 * Description
 */

class MyClass{

}