对于不同的编程语言来说,具体的编码规范可以有很大的不同,但是其宗旨都是一致的,就是保证代码在高质量完成需求的同时具备良好的可读性、可维护性。例如我们可以规定某个项目的C语言程序要遵循这样的规定:变量的命名,头文件的书写和#include
等等。
下面是一些广为采用的编码规范:
- GNU Coding Standards
- Guidelines for the Use of the C Language in Vehicle Based Software
- C++ Coding Guidelines
- SUN Code Conventions for Java
以下是一些介绍编码、编码规范的书籍:
- C++编码规范,陈世忠,人民邮电出版社,2002
- 高质量程序设计指南:C++/C语言,林锐等,电子工业出版社,2003
注:以下只是根据课题组已有的经验给出的总结,并非对所有场景均适用。
对于高质量的工程,一般会做到:
- 代码简洁精炼,美观,可读性好,高效率,高复用,可移植性好,高内聚,低耦合,没有冗余,不符合这些原则,必须特别说明。
- 规范性,代码有规可循。特殊排版、特殊语法、特殊指令,必须特别说明。
一、文件排版方面
包含头文件
1.1 先系统头文件,后用户头文件。
1.2 系统头文件,稳定的目录结构,应采用包含子路径方式。
1.3 自定义头文件,不稳定目录结构,应在dsp中指定包含路径。
1.4 系统头文件应用:#include <xxx.h>
1.5 自定义同文件应用:#include "xxx.h"
1.6 只引用需要的头文件。h和cpp文件
2.1 头文件命名为*.h
,内联文件命名为*.inl
;C++文件命名为*.cpp
2.2 文件名用大小写混合,或者小写混合。例如DiyMainView.cpp
,infoview.cpp
。不要用无意义的名称:例如XImage.cpp
;SView.cpp
;xlog.cpp
;
2.3 头文件除了特殊情况,应使用#ifdef
控制块。
2.4 头文件#endif
应采用行尾注释。
2.5 头文件,首先是包含代码块,其次是宏定义代码块,然后是全局变量,全局常量,类型定义,类定义,内联部分。
2.6 CPP文件,包含指令,宏定义,全局变量,函数定义。文件结构
3.1 文件应包含文件头注释和内容。
3.2 函数体类体之间原则上用2个空行,特殊情况下可用一个或者不需要空行。空行
4.1 文件头、控制块,#include
部分、宏定义部分、class
部分、全局常量部分、全局变量部分、函数和函数之间,用两个空行。
二、注释方面
文件头注释
1.1 作者,文件名称,文件说明,生成日期(可选)