+ -
当前位置:首页 → 问答吧 → 请好心推荐下你的文档注释格式

请好心推荐下你的文档注释格式

时间:2011-12-24

来源:互联网

我想好好学下C语言,也包括代码编写格式,

希望有好人心能提供一下给我参考下,

1.函数的注释模式 
2.文档的注释格式 
3.代码的排版风格

再下在此先行谢谢了。

作者: asmfox   发布时间: 2011-12-24

函数注释:
<FUNCATION>
SYNTAX:
  BOOL Func(int id);
PARAMETER:
  int id - the id
RETURN:
  TRUE - OK
  FALSE - failed
</FUNCATION>
代码排版:(好多规则)
缩进 - 8空格,不留制表符
块定义 - 必用花括号
if (cond)
{
  okok
}
变量声明 - 每行只声明一个变量,例如
int a;
int b;
绝不会这样
int a, b;
说都说不完,不说了。

作者: baby393   发布时间: 2011-12-24