C编程从入门到实践
上QQ阅读APP看书,第一时间看更新

3.1 养成好的命名习惯

知识点讲解:视频\第3章\养成好的命名习惯

任何应用程序在编写完毕后,都要为其命名,在命名时最好要遵循科学合理的命名规则。概括来说,应该遵循如下3条规则。

(1)函数名用大写字母开头的单词来命名。例如:

    void InitPort(void);
    void UpDisplay(void);

(2)变量用小写字母开头的单词来表示。例如:

    uchar openLight;
    uchar closeLight;

(3)常量用全大写的字母,并用下画线分隔单词。例如:

    #define  MAX_TIME 10
    #define  MIN_TIME 100

由于C语言是一种简洁的语言,因此其命名也应该是简洁的。同其他主流语言不同的是,编写C语言的程序员不使用ThisVariableIsATemporary之类的命名方式。一个C语言的程序员会将其命名为“tmp”,这很容易书写,且不难理解。

当混合类型的名字不得不出现的时候,描述性名字对全局变量来说是很有必要的,调用一个名为“foo”全局函数是很让人烦的。全局变量就像全局函数一样,需要描述性的命名方式。假如有一个函数用来计算活动用户的数量,那么应该用如下的命名方式。

    count_active_users()

或者使用另外相近的形式,但是不应命名为下面的形式。

    cntusr()

有一种称为Hungarian的命名方式,它将函数的类型编码写入变量名中,建议读者不要使用这种方式。因为编译器通常知道这个类型而且会去检查它,所以这样只会迷惑程序员。

局部变量的命名应该短小精悍。假如你有一个随机的整数循环计数器,那么它有可能是“i”,如果没有任何可能会使它被误解的话,则将其写作“loop_counter”是效率低下的。同样的“tmp”可以是任何临时数值的函数变量。

为了便于后期的程序维护,建议使用表示具体功能的描述字符来作为程序文件名或函数名。例如一个函数的功能是计算,则命名为sum。