C语言编程规范之命名规则【C语言篇】

声明：本文章是对林锐博士的《高质量 C++/C 编程指南》一书中进行总结概括，可靠性可以放心食用。

---

共性规则

1）标识符应当直观且可以拼读，可望文知意，不必进行“解码”。

       1、标识符最好采用英文单词或其组合（切忌使用汉语拼音来命名）

       2、用词应当准确，例如不要把 CurrentValue 写成 NowValue。

2）标识符的长度应当符合“min-length && max-information”原则（不要太长也不要太短）。

        1、例如变量名 maxval 就比 maxValueUntilOverflow 好用。

        2、单字符的名字也是有用的，常见的如 i,j,k,m,n,x,y,z 等，它们通常可用作函数 内的局部变量。

3）命名规则尽量与所采用的操作系统或开发工具的风格保持一致。

        1、Windows 应用程序的标识符通常采用“大小写”混排的方式，如 AddChild。

        2、Unix 应用程序的标识符通常采用“小写加下划线”的方式，如 add_child。

4）程序中不要出现仅靠大小写区分的相似的标识符。

        1、int x, X;         // 变量 x 与 X 容易混淆

5）程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的 作用域不同而不会发生语法错误，但会使人误解。

6）变量的名字应当使用“名词”或者“形容词＋名词”。

7）全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。 类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。

        1、DrawBox();         // 全局函数

        2、box->Draw();         // 类的成员函数

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

        1、int minValue; int maxValue;

9）尽量避免名字中出现数字编号，如 Value1,Value2 等，除非逻辑上的 确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名 字（因为用数字编号最省事）。

---

“匈牙利”

作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合 于 Windows 应用软件的开发。

1）类名和函数名用大写字母开头的单词组合而成

        class Node; // 类名

        class LeafNode; // 类名

        void Draw(void); // 函数名

        void SetValue(int value); // 函数名

2）变量和参数用小写字母开头的单词组合而成。

        BOOL flag;

        int drawMode;

3）常量全用大写的字母，用下划线分割单词。

        const int MAX = 100;

        const int MAX_LENGTH = 100;

4）静态变量加前缀 s_（表示 static）

        void Init(…)

        {

                static int s_initValue; // 静态变量 …

        }

5）如果不得已需要全局变量，则使全局变量加前缀 g_（表示 global）

        int g_howManyPeople; // 全局变量

        int g_howMuchMoney; // 全局变量

6）类的数据成员加前缀 m_（表示 member），这样可以避免数据成员与 成员函数的参数同名。

        void Object::SetValue(int width, int height)

        {

                m_width = width; m_height = height;

        }

7）为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为 各种标识符加上能反映软件性质的前缀。例如三维图形标准 OpenGL 的所有库函数 均以 gl 开头，所有常量（或宏定义）均以 GL 开头。

---

END~~