如何写漂亮的c评论的例子

前端之家收集整理的这篇文章主要介绍了如何写漂亮的c评论的例子前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
也许是愚蠢的问题,但有没有办法写好看(短)格式
写c函数,标题,变量的注释?任何视觉例子?

解决方法

你好漂亮的意思是什么意思?
我这样做..
int c;//! loop Counter

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

它的doxygen格式.有一些populer格式用于在Comment中记录代码. Doxygen是一个,另一个是naturaldocs.还有更多.它的味道.你甚至可能喜欢naturaldocs格式.

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

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

DOC格式也像similer一样.

/** Comparison
    Compare two Types

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

只使用一种格式并坚持下去.

猜你在找的C&C++相关文章