C语言变量和函数命名规范

来源:互联网 发布:quickfix java 编辑:程序博客网 时间:2024/05/24 05:37

C 语言变量和函数命名规范: 关于C语言变量和函数命名规范 据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多 精力试图发明世界上最好的命据考察,没有一种命名规则可以让所有的程序员赞同,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施


1. 共性规则

    本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则

【规则1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。

    标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。


【规则1-2】标识符的长度应当符合“min-length && max-information”原则。

    几十年前老ANSI C规定名字不准超过6个字符,现今的C++/C不再有此限制。一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么 名字是否越长约好?不见得! 例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们 通常可用作函数内的局部变量。

【规则1-4】程序中不要出现仅靠大小写区分的相似的标识符。

    例如:

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

  void foo(int x);  // 函数foo 与FOO容易混淆

  void FOO(float x);


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


【规则1-6】变量的名字应当使用“名词”或者“形容词+名词”。

    例如:

    float value;

  float oldValue;

  float newValue;


【规则1-7】全局函数的名字应当使用“动词”或者“动词+名词”(动宾词组)。类的成员函数应当只使用“动词”,被省略掉的名词就是对象本身。

    例如:

    DrawBox();  // 全局函数

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


【规则1-8】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

  例如:       

int     minValue;    

    int    maxValue;    

    int    SetValue(…);    

    int     GetValue(…);              


 2. 简单的Windows应用程序命名规则

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

    【规则2-1】类名和函数名用大写字母开头的单词组合而成。

    例如:

          class  Node;      // 类名

               class LeafNode;    // 类名

               void  Draw(void);   // 函数名

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


C语言变量和函数命名规范(2):

 【规则2-2】变量和参数用小写字母开头的单词组合而成。

    例如:

  BOOflag; int  drawMode;


    【规则2-3】常量全用大写的字母,用下划线分割单词。

    例如:

  const int MAX =  100;     const int MAX_LENGTH =  100;


    【规则2-4】静态变量加前缀s_(表示static)。

    例如:

  void Init(…)      {      static  int s_initValue; // 静态变量      …     }


    【规则2-5】如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。

    例如:

    int g_howManyPeople;    // 全局变量

  int g_howMuchMoney;    // 全局变量


    【规则2-6】类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

    例如:

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

  {

  m_width = width;

  m_height = height;

  }


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





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

   例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。别把这两类风格混在一起用。


0 0