简单编程规范

 

UNIX编程风格：

1、关键字之后要留空格

象const、 virtual、inline、 case等关键字之后要留一个空格，否则无法解析关键字。像if、for、while等关键字之后要留一个空格再跟一个左括号‘（’，以突出关键字。

函数名之后不要留空格，紧跟左括号‘（’， 以与关键字区别。

2、‘（’向前紧跟，‘）’、‘，’、‘；’向前紧跟，紧跟处不留空格。

3、‘，’、‘；’之后要留空格

如function(x, y, z); for(initialization; condition; update)

4、对齐只使用空格键，不使用TAB键

5、自己特有的命名风格，要自始至终保持一致，不可来回变化

6、标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。

说明：较短的单词可通过去掉“元音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有大家公认的缩写。

示例：如下单词的缩写能够被大家基本认可。

temp 可缩写为  tmp  ;

flag 可缩写为  flg  ;

statistic 可缩写为  stat ;

increment 可缩写为  inc  ;

message 可缩写为  msg  ;

7、变量的名字应当使用“名词”或者“形容词+名词”,静态变量前加S_;全局变量前加g_

如：float value;

                  float old_value;

                  float new_value;

8、避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的枚举或宏来代替。

          用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

说明：下面是一些在软件中常用的反义词组。

add / remove       begin / end        create / destroy

insert / delete    first / last       get / release

increment / decrement                 put / get

add / delete       lock / unlock      open / close

min / max          old / new          start / stop

next / previous    source / target    show / hide

send / receive     source / destination

cut / paste        up / down

9、使用动宾词组为执行某操作的函数命名。如果是OOP方法，可以只有动词（名词是对象本身）。

示例：参照如下方式命名函数。

void print_record( unsigned int rec_ind ) ;

int  input_record( void ) ;

unsigned char get_current_color( void ) ;

10、防止将函数的参数作为工作变量。

说明：将函数的参数作为工作变量，有可能错误地改变参数内容，所以很危险。对必须改变的参数，最好先用局部变量代之，最后再将该局部变量的内容赋给该参数。