【C语言】C编程的基本素养(编程范式)

本文是介绍在C语言编程中，对变量和函数的命名一般原则和建议，以及排版的一些例子。（PS：我不知道这种叫不叫“编程范式”，我只是希望每个开发者都严格要求自己写出风格较为统一的代码，方便他人阅读。）

---

Table of Contents

三种命名方法

命名原则

我的代码排版

---

三种命名方法

 

骆驼命名法：

 

1. 小驼峰法（camel方法）：变量一般用小驼峰法标识。
   • 格式：第一个单词以小写字母开始；第二个单词的首字母大写或每一个单词的首字母都采用大写字母；
   • 例子：myFirstName、myLastName
2. 大驼峰法（Upper Camel Case）：又称帕斯卡命名法（pascal方法），常用于类名，函数名，属性，命名空间。
   • 格式：相比小驼峰法，大驼峰法把第一个单词的首字母也大写了。
   • 例子：MyFirstName，如Java就是采用骆驼命名法。

 

下划线命名法：

 

• 格式：词与此之间用一个下划线分割开来；
• 特点：下划线命名法中，函数名中的每一个逻辑断点都有一个下划线来标记。骆驼命名法中，函数名中的每一个逻辑断点都有一个大写字母来标记。
• 例子：my_first_name，my_last_name，在Python中建议使用这种方式

 

匈牙利命名法：

 

1. 格式：前缀 + 真正的变量名
2. 解释：前缀（一个或者多个小写字母开头作为前缀），前缀表明该变量的类型；真正的变量名（前缀之后的是首字母大写的一个单词或多个单词组合）
3. 例子：aStudentArray，该变量前面的“a”表示这个变量是一个数组变量，“StudentArray”表示这个变量的意义
4. 如Windows平台的系统API就是采用匈牙利命名法。

 

有一个开源项目，可以帮助你命名：

CODELF（https://unbug.github.io/codelf/）

---

命名原则

 

Force Syntax：

1. 只能以字母或下划线开始；

2. 不能以数字开始；

3. 关键字、保留字不允许用（如float，double）；

 

变量、函数命名的一般原则：

1. C 是一种简洁的语言, 命名也应该是简洁的。
2. 命名应当直观且可以拼读，可望文知意，便于记忆和阅读。
3. 标识符最好采用英文单词或其组合，不允许使用拼音。
4. 程序中的英文单词一般不要太复杂，用词应当准确。例如变量名MaxVal 就比MaxValueUntilOverflow 好用。标识符的长度一般不要过长，较长的单词可通过去掉“元音”形成缩写。
5. 命名的长度应当符合“min-length && max-information”原则。另外，英文词尽量不缩写，特别是非常用专业名词，如果有缩写，在同一系统中对同一单词必须使用相同的表示法，并且注明其意思。
6. 当标识符由多个词组成时，每个词的第一个字母大写，其余全部小写。比如：int CurrentVal；一个词时就小写；这样的名字看起来比较清晰，远比一长串字符好得多。
7. 也即，C语言推荐使用大驼峰法命名法！
8. 所有宏定义、枚举常数、只读变量全用大写字母命名，用下划线分割单词。

 

注意事项：

1. 尽量避免名字中出现数字编号，如Value1,Value2 等，除非逻辑上的确需要编号。比如驱动开发时为管脚命名，非编号名字反而不好。
2. 初学者总是喜欢用带编号的变量名或函数名，这样子看上去很简单方便，但其实是一颗颗定时炸弹，也即这种命名方法是错误的。这个习惯初学者一定要改过来。
3. 程序中不得出现仅靠大小写区分的相似的标识符。这里还有一个要特别注意的就是1（数字1）和l（小写字母l）之间，0（数字0）和o（小写字母o）之间的区别。这两对真是很难区分的，我曾经的一个同事就被这个问题折腾了一次。

 

如何给变量命名：

1. 变量的命名使用名词性词组。
2. 变量含义标识符构成：目标词+ 动词(的过去分词)+ [状语] + [目的地]；

 

如何给函数命名：

1. 函数的命名使用动词性词组。
2. 函数含义标识符构成：动词(一般现时)+目标词+[状语]+[目的地]；

我的代码排版

 

---