美文网首页程序员
有意义的命名

有意义的命名

作者: 书上得来终觉浅 | 来源:发表于2016-12-20 10:04 被阅读31次
    • 当发现更合理的命名时,可以随时替换。
    • 变量、函数和类要依义命名,好的命名可以不用补充注释就知道其用途。好命名能有效的降低代码的模糊度。
    • 尽量避免数字系列命名(a1,a2,...aN),例如
    public void copyChars(char a1[],char a2[])
    {
          for(int i = 0; i < a1.length; i++)
          {
              a2[i] = a1[i];
          }
    }
    

    将变量a1替换为source,a2替换为destination,可读性就会增强许多。

    public void copyChars(char source[],char destination[])
    {
          for(int i = 0; i < source.length; i++)
          {
              destination[i] = source[i];
          }
    }
    
    • 尽量减少命名中无意义的单词。比如Customer代表顾客,那么用CustomerInfo来命名顾客类,就显得无意义,这里的Info就是冗余的。
    • 使用能读出来的名称,应恰当的使用英文单词,不应该使用自造词,拼音首字母组合等命名。
    • 如果一个常量在代码中多处使用,则应该赋予其一个的名称,以便于搜索和记忆。列如,工程中默认外边距是8,所有布局代码中都使用这个默认边距,则可用定义一个宏来命名该常量。
    #define MARGIN_DEFAULT 8
    
    • 精确是命名的要点,一般类名用名词或名词短语,方法名用动词或动词短语。

    相关文章

      网友评论

        本文标题:有意义的命名

        本文链接:https://www.haomeiwen.com/subject/atqxvttx.html