zoukankan      html  css  js  c++  java
  • 编程常用命名大全

    随着编程工作的深入,我深刻的体会到,最浪费程序员时间的不仅仅是BUG,还有取名。

    每次新建一个类,一个变量,一个函数,都tm的要想半天到底取什么名字,真的是好浪费时间。

    所以为了跟别的妖艳贱货不一样,我正打算把常用的命名记录下来,并整理编程的命名原则和命名规范,

    整理出来贴在我的博客并置顶,我觉得这样会大大节省我的编程时间,提高编程效率。

    直到有一天,我能熟练的掌握相关规范,不会再因取名字而纠结,就取消置顶。

    一、共性规则

    1>“匈牙利”命名法:在变量和函数名中加入前缀以增进人们对程序的理解;

    eg:

    class CStude;

    int  nCount;

    int* pCount;

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

    标识符最好采用英文单词或其组合,便于记忆和阅读。切忌使用汉语拼音来命名。

    程序中的英文单词一般不会太复杂,用词应当准确。例如不要把CurrentValue写成NowValue。

     

    3>标识符的长度应当符合“min-length && max-information”原则。

    几十年前老ANSI C规定名字不准超过6个字符,现今的C++/C不再有此限制。一般来说,长名字能

    更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。那么名字是否越长约好?

    不见得! 例如变量名maxval就比maxValueUntilOverflow好用。单字符的名字也是有用的,常见的

    如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。

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

    例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。而Unix应用程序的标

    识符通常采用“小写加下划线”的方式,如add_child。别把这两类风格混在一起用。

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

    eg:

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

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

    void FOO(float x);

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

    7>变量的名字应当使用“名词”或者“形容词+名词”。

    eg:

    float value;

    float oldValue;

    float newValue;

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

    eg:

    DrawBox();                  // 全局函数

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

     

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

    eg:

    int     minValue;

    int     maxValue;

    int     SetValue(…);

    int     GetValue(…);

     

    10>尽量避免名字中出现数字编号,如Value1,Value2等,除非逻辑上的确需要编号。这是为了防止程序员

    偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事)。

     

    二、简单的Windows应用程序命名规则

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

    eg:

         class Node;                      // 类名

         class LeafNode;                  // 类名

         void Draw(void);           // 函数名

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

     

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

    eg:

    bool flag;

    int drawMode;

     

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

    eg:

    const int MAX = 100;

    const int MAX_LENGTH = 100;

     

    4>类的数据成员加前缀m_(表示member),这样可以避免数据成员与成员函数的参数同名。

    eg:

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

         {

             m_width = width;

        m_height = height;

    }

    5>为了防止某一软件库中的一些标识符和其它软件库中的冲突,可以为各种标识符加上能反映软件性

    质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。

     

    三、常用的命名单词


    这里是我这三个月的编程中所积累到的常用的单词;其实有了这些,再加上之前的命名规范,命名就会变的如此简单

    getInstance    //获得实例
    upData        //数据更新
    onRender    //渲染    
    init...        //初始化...
    set...        //设置/更改 
    loadFile    //装载文件
    add..by..    //添加...
    moveDown    //移动
    backup        //备份
    revert        //恢复
    count        //计数
    londFile    //读取文件
    Birth        //初始
    Vaule        //
    index        //索引
    create...    //创建        
    Entity      //(父类用)
    Monster        //怪物
    Scene        //场景
    Node        //节点
    director    //主管
    stance        //立场
    select        //挑选
    refresh        //更新、使.....恢复
    Global         //全局、全球
    Register    //注册
    Controller     //控制器

    俗话说的好,没有一种命名规则可以让所有的程序员赞同。命名规则对软件产品而言并不是“成败悠关”的事,

    我们不要化太多精力试图发明世界上最好的命名规则,我今天整理的命名规则只是一种参考,跟个人有关。

  • 相关阅读:
    Bootstrap导航组件
    Bootstrap输入框组
    Bootstrap按钮式下拉菜单
    Bootstrap按钮组
    Bootstrap下拉菜单
    Bootstrap 中的 aria-label 和 aria-labelledby
    js 在函数中遇到的this指向问题
    js中 clientWidth offsetWidth scrollWidth等区别
    小程序--授权封装
    小程序--分享功能
  • 原文地址:https://www.cnblogs.com/kpxy/p/9843556.html
Copyright © 2011-2022 走看看