我的代码格式

原创 2007年09月11日 18:01:00
1. 在.h/.cpp的开头应有一段格式统一的说明,格式如下:
// 
//
// 文 件 名:
// 简    述:
//  作    者:OutSky
// 最后更新:xxxx年xx月xx日
/////////////////////////////////////////////////////////////////////////////

2.对于主要功能函数应有注释说明。格式为:
 
/////////////////////////////////////////////////////////////////////////////
//    函 数 名:    
//    简    述:    
//    参    数:(参数名、意义)
//    返 回 值:(返回值类型、意义)
//    注    意:(需要注意的信息)
/////////////////////////////////////////////////////////////////////////////


3. 每列代码的长度推荐为80列,最长不得超过120列;折行以对齐为准。
例:HANDLE KSOpenFile(const char cszFileName[], 
int nMode); 
或者: 
BOOL KSReadFile( 
HANDLE hFile, 
void *pvBuffer, 
int nReadSize, 
int *pnReadSize 
); 

4. 循环、分支代码,判断条件与执行代码不得在同一行上。
例:正确: 
if(-2 == n) 
    n 
= 1
else 
    n 
= 2
不得写做: 
if (-2 == n) n = 1
else n = 2

5. 指针的定义,* 号紧接变量名。
例:正确:
int *pNum;
错误1:
int* pNum;
错误2:
int * pNum;
6.返回指针时,*号紧跟返回值类型。
例:正确:
int* fun();
错误1:
int *fun();
错误2:
int * fun();


7. 函数入口参数有缺省值时,应注释说明。
例: 
BOOL KSSaveToFile( 
const char cszFileName[], 
BOOL bCanReplace 
/* = TRUE */ 
); 
8. else if 必须写在一行。
9.‘{’必须另起一行。‘{’与‘}’必须在同一列上。类中定义的内联函数等特殊情况除外。
例:正确: 
if (i > 0

= 1
n
++
}
 
不得写做: 
if (i > 0
= 1
n
++
}
 

 

10.if语句、while语句格式:
情况1:条件只有一个,则在条件语句两侧各空一格,如:
if( a<b )
while( a<b )
情况2:条件多于一个,则条件之间空格,两侧不空格,如:
if(a<&& d<c)
while(a<&& d<c)
11.for语句格式:
空格位置如例:
类型1: 
for(int a=0; a<10++a)
类型2: 
for(a=0, b=1; a<10&&b<10++a,++b)
12.普通注释格式:
情况1:注释内容较少,所要注释的代码也很短。注释放在代码同一行的右边。
int nNum;    // 小球的个数
情况2:注释内容不多,但所要注释的代码很长。注释放在代码上一行。
// 所有物品的总数
int nNum = nNumObjA+nNumObjB+nNumObjC+......
情况3:注释的内容很多,放在代码上面,用
/* */注释。
/*
1.什么什么什么
2.什么什么什么
3.。。。
*/

继续添加。。。

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

提交Android代码的格式

http://source.android.com/source/code-style.html#follow-field-naming-conventions Code Sty...

支持各种格式的网页播放器控件代码

1.avi格式 代码片断如下: 2.mpg格式 代码片断如下: ...

C#之WinForm基础 图片查看器升级版(代码定格式),textbox定文件夹,用listbox、picturebox

镇场诗:慈心积善融学习,技术誓为大家学。善心速造多好事,前人栽树后乘凉。我今于此写经验,愿见文者得启发。 ——————————————————————————————————————————————...

OpenCORE原理和核心代码破解,增加AVI格式。

<!-- @page {margin:2cm} p {margin-bottom:0.21cm} h1 {margin-bottom:0.21cm} h1.western {f...

leveldb代码阅读(12)——数据库日志文件格式

原文地址:http://www.blogjava.net/sandy/archive/2012/03/09/leveldb3.html leveldb在每次数据库操作之前都会把操作记录下来。 主要...

通过Pojo对象 field 属性加注解实现格式校验,极大的减少代码量

最近做一个接口,接受外系统的报文,通过XStream转换成java对象以后,需要对其中的字段做格式校验。要求如下: 传统的方式是硬编码校验,但是对于field很多的情况,代码量暴增。容易出错。...

vim中键粘贴---导致代码格式混乱 --解决办法!

转载▼ 我以为,linux中键粘贴是个很好的功能 我经常会从网页上粘一点代码到编辑器中,结果我通常都会发现,粘到vim中格式都会乱到无法阅读 然后,我通常都会用indent来...

AStyle代码格式工具在source insight中的使用

一、AStyle下载路径   Astyle为开源项目,支持C/C++和java的代码格式化   Home Page: http://astyle.sourceforge.net/   Proje...
  • gw_cs
  • gw_cs
  • 2012-08-31 09:57
  • 26354

pig代码格式上小注意

1,%default file test.txt 中不要用引号,'' 和“”都不行。'file'不会被识别 2,等号=两边要注意。前必须空,后可以不空。 所以格式最好保持,等号两边都有空格。如A ...

自动生成代码的chm格式帮助文档

在Visual Studio下编程,有两个很方便的生成chm帮助文档的工具。它们就是Sandcastle Help File Builder 和Sandcastle。Sandcastle Help F...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)