1.当项目比较大时,最好分模块编程,一个模块一个程序
方便修改,也便于重用和便于阅读。
2.每个文件的开头应该写明这个文件是哪个项目里的哪个模块,是在什么编译环境下编译的,编程者(/修改者)和编程日期,值得注意的是一定不要忘了编程日期,因为以后你再看文件时,会知道大概是什么时候编写的,有些什么功能,并且可能知道类似模块之间的差异(有时同一模块所用的资源不同,和单片机相连的方法也不同,或者只是在原有的模块上加以改进)。
比如:
//以下是《模块》或《文件》注释内容:
/
//公司名称:
//模 块 名:
//创 建 者:
//修 改 者:
//功能描述:
//其他说明:
//版 本:
/
//以下是《函数》注释内容:
/
//函 数 名:
//功能描述:
//函数说明:
//调用函数:
//全局变量:
//输 入:
//返 回:
//设 计 者:
//修 改 者:
//版 本:
/
3.一个C源文件配置一个h头文件或者整个项目的C文件配置一个h头文件,
并且使用#ifndef/#define/#endif的宏来防止重复定义,方便各模块之间相互调用。
//pipe.h
#ifndef __INCLUDE_PIPE_H__
#define __INCLUDE_PIPE_H__
#endif //__INCLUDE_PIPE_H__
4.一些常量(如圆周率PI)或者常需要在调试时修改的参数最好用#define定义,
但要注意宏定义只是简单的替换,因此有些括号不可少。
5、缩进与空行:缩进以Tab为单位,一个Tab为四个空格大小。程序文件
结构各部分之间空两行,若不必要也可只空一行,各函数实现之间一般空两行。
6.书写代码时要注意括号对齐,固定缩进,一个{}各占一行,建议采用所进4个字符,if/for/while/do等语句各占一行,执行语句不得紧跟其后,无论执行语句多少都要加{},千万不要写成如下格式:
for(i=0;i<100;i++){fun1();fun2();}
for(i=0;i<100;i++){
fun1();
fun2();
}
而应该写成:
for(i=0;i<100;i++)
{
fun1();
fun2();
}
7.一行只实现一个功能,比如:
a="2"; b=3; c=4;宜改成:
a="2";
b="3";
c="4";
8.重要难懂的代码要写注释,每个函数要写注释,每个全局变量要写注释,
一些局部S变量也要写注释。注释写在代码的上方或者右方,千万不要写在下方.
9. 对各运算符的优先级右所了解,记不得没关系,加括号就是,不可以"自以为是"。
10.不管有没有无效分支,switch函数一定要defaut这个分支。一来让阅读者知道程序员并没有遗忘default,并且防止程序运行过程中出现的意外(健壮性)。
11.变量和函数的命名最好能做到望文生义。
不要命名什么x,y,z,a,sdrf之类的名字。
12.函数的参数和返回值没有的话最好使用void。
13.goto语句:C中尽量不要去使用goto。
14.指针是C语言的精华,但在使用时一定要确定"了解他"。