好的编码规范
2016-07-21 15:12
211 查看
编码规范不是硬性要求,这只是良好的习惯,好习惯可以避免很多不必要的失误,我今天就简单的讲述一下,在编程时我们应该注意什么。
1.在程序的排版方面,一开始我们应该用/* 说明这个程序的版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。*/便于讲述此程序的作用
2.写头文件时,标准库文件用<>包含,非标准库文件用“”包含。
3.应尽量使用宏定义常量,便于后期的修改和维护
4.使用四字缩进,最好使用空格缩进,不要用tab键,避免各个系统tab缩进不同。
5.保证一行只写一个程序,如果一个程序过长,可分行写,但请尽量保持相同种类的写在一列,清晰明了。for,while,if,do等语句,请尽量只占一行,就算只有一个语句,也要用 { } 括起来,并且各占一行,不要怕使用换行,系统不计算空行的内存。
6.定义变量时,保证一行只定义一个变量,并且同种类型的变量放在一起,不同类型变量之间空一行。
7.不同模块间要空一行,比如写了一个功能,在写下一个功能时请空一行,怎么让人看的舒服怎么来。
8.运算符之间应留有空格,比如for(i = 0; i < 10; i++),不要把程序都堆在一起,适当留有空格,让人看的舒缓。
9.程序之间应该对齐,不管是语句还是括号{},都要对齐,让人一目了然。
10.修饰符紧靠变量,这样可以知道是哪个变量的修饰符,避免混淆。
11.注释不要多,但要有,只起解释说明作用,不要罗里吧嗦的,只简单提一下就可。
12.命名时,使用英文单词组合,动词加名词,比如get_num,insert _ ch等。能够望名生意。
13.使用多个运算符运算时,不要使用默认优先级,自己加括号,保证程序准确。
14.语句嵌套使用时,请严格按照四格缩进,不要图省事。
15.写函数时,函数名恰当合理,形参返回值写完整,有就有,没有就void。
以上是总体上排版上应该这么写,要想达到高效优美的程序,还有很多路要走,还有很多注意点,比如入口参数检查,返回值判断(异常处理)等。
1.在程序的排版方面,一开始我们应该用/* 说明这个程序的版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。*/便于讲述此程序的作用
2.写头文件时,标准库文件用<>包含,非标准库文件用“”包含。
3.应尽量使用宏定义常量,便于后期的修改和维护
4.使用四字缩进,最好使用空格缩进,不要用tab键,避免各个系统tab缩进不同。
5.保证一行只写一个程序,如果一个程序过长,可分行写,但请尽量保持相同种类的写在一列,清晰明了。for,while,if,do等语句,请尽量只占一行,就算只有一个语句,也要用 { } 括起来,并且各占一行,不要怕使用换行,系统不计算空行的内存。
6.定义变量时,保证一行只定义一个变量,并且同种类型的变量放在一起,不同类型变量之间空一行。
7.不同模块间要空一行,比如写了一个功能,在写下一个功能时请空一行,怎么让人看的舒服怎么来。
8.运算符之间应留有空格,比如for(i = 0; i < 10; i++),不要把程序都堆在一起,适当留有空格,让人看的舒缓。
9.程序之间应该对齐,不管是语句还是括号{},都要对齐,让人一目了然。
10.修饰符紧靠变量,这样可以知道是哪个变量的修饰符,避免混淆。
11.注释不要多,但要有,只起解释说明作用,不要罗里吧嗦的,只简单提一下就可。
12.命名时,使用英文单词组合,动词加名词,比如get_num,insert _ ch等。能够望名生意。
13.使用多个运算符运算时,不要使用默认优先级,自己加括号,保证程序准确。
14.语句嵌套使用时,请严格按照四格缩进,不要图省事。
15.写函数时,函数名恰当合理,形参返回值写完整,有就有,没有就void。
以上是总体上排版上应该这么写,要想达到高效优美的程序,还有很多路要走,还有很多注意点,比如入口参数检查,返回值判断(异常处理)等。
相关文章推荐
- Ubuntu16.04下安装Hadoop2.6.2 (单机模式)
- 新手Android学习笔记 02——关于R包的错误
- 新手Android学习笔记 02——关于R包的错误
- PHP Session变量,实现session服务器端存储用户信息,阻止未登录跳转主页
- java中使用excel导入数据
- 存储知识学习之--IP网络存储iSCSI的概念与工作原理
- ACM暑期集训——专题一[BFS]
- python手记-twisted(5)
- Android 框架练成 教你打造高效的图片加载框架
- 【渗透测试学习平台】 web for pentester -1.介绍与安装
- umask默认权限分配
- Linux 权限基础说明
- First Missing Positive
- 使用java发送邮件
- win7 exe 修改程序内存使用2G上限问题
- String,StringBuilder,StringBuffer
- https://jitpack.io
- c++实现字符串回文判断
- Android保存数据到SharedPreferences
- 顺序查找