c++ - 如何编写漂亮的 C++ 注释的示例

Question

<分区>

Answer 1

这里的好看是什么意思？ 我是这样做的..

int c;//! loop Counter

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

它的 doxygen 格式。 Comment 中有用于记录代码的流行格式。 Doxygen 是一个，另一个是 naturaldocs。还有更多。这是你的味道。您甚至可能喜欢 naturaldocs 格式。

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

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

DOC++格式也类似。

/** Comparison
    Compare two Types

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

只使用一种格式并坚持使用。