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

发布时间：2020-12-16 03:23:08 所属栏目：百科来源：网络整理

导读：也许是愚蠢的问题,但有没有办法写好看(短)格式写c函数,标题,变量的注释？任何视觉例子？解决方法你好漂亮的意思是什么意思？我这样做.. int c;//! loop Counter/** * compares (XOR) two Types * return boolean result */bool compare(Type l,Type r);

也许是愚蠢的问题,但有没有办法写好看(短)格式
写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);

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!