美文网首页
一、代码整洁之道:命名

一、代码整洁之道:命名

作者: 程序猿_K | 来源:发表于2020-05-19 22:21 被阅读0次

    1.名副其实

    变量、函数或类的名称应该答复了所有的大问题。比如它为什么存在,它做什么事情,应该怎么用。如果名称需要注释来补充,那就不是名副其实。

    int d;// 消逝的时间,以日计
    

    名称d什么野没说明,他没有引起对时间消逝的感觉,更别说以日计。
    我们应该指明计量对象和计量单位的名称:

    int elapsedTimeInDays;
    int daysSinceCreation;
    int daysSinceModification;
    int fileAgeInDays;
    

    2.避免误导

    程序员必须避免留下掩藏代码本意的错误线索。应当避免使用与本意相悖的词。

    别用accountList来指称一组账号,除非它真的是List类型。List一词对程序员有特殊意义。

    提防使用不同之处较小的名称。

    XYZControllerForEfficientHandlingOfString 和另一处 XYZControllerForEfficientStorageOfString ,区分起来会很花时间。

    3.做有意义的区分

    如果程序员只是满足编译器或解释器的需要而写代码,就会制造麻烦。

    例如,因为同一作用范围内两样不同的东西不能重名,你可能会随手改掉其中一个的名称。有时干脆以错误的拼写充数,结果就是现在更正拼写后导致编译器出错的情况。

    public static void copyChairs(char a1[],char a2[]) {
       for(int i = 0, i < a1.length, i ++) {
            a2[i] = a1[i];
       }
    }
    

    如果修改名称为source和destination,这个函数就会像样许多。
    废话是另一种没有意义的区分。假如你有两个Product类,还有一个叫ProductInfo 或者 ProductData 类,那他们的名称虽然不一样,意思却无区别。

    4.使用读得出来的名称

    人类长于记忆和使用单词,名称读不出来,感觉就是沟通困难。

    有家公司,程序里面写了一个 genymdhms(生产日期,年、月、日、时、分、秒),他们一般读作“gen why emm dee aich emm ess”即字母的读音,有见字读音的习惯就会读成“gen-yah-mudda-hims”。后来人根本不知道这个名词的意义。这是自造词,而非恰当的英语词。

    class DtaRcrdl02 {
      private Date genymdhms;
      private Date modymdhms;
      private final String pszqint = "102";
     ...
    };
    class Custmer{
       private Date generationTimestamp;
       private Date modificationTimestamp;
       private final String recordId = "102";
     ...
    }
    

    5.使用可搜索的名称

    单字母名称和数字常量有个问题,就是很那在一大篇文字中找出来。

    找MAX_CALSSES_PER_STUDENT 很容易,找到一个数字7就很困难了。

    6.避免使用编码

    编码已经太多,无畏再自找麻烦。

    把类型或作用域编进名称里面,徒然增加了解码的负担。带编码的名称也不方便发音,容易打错。

    PhoneNumber phoneString;// 类型变化时,名称并不变化
    

    有时会出现采用编码的特殊情形。比如,你在做一个创建形状的抽象工厂(AbstractFactory)。该工厂是个接口,要用具体的类来实现。怎么命名呢?IShapeFactory 和 ShapeFactory 吗?肯定ShapeFactory。前缀字母I被滥用,说好听是干扰,说难听点就是废话的程度。

    7.避免思维映射

    不应当让读者在脑中把你的名称翻译成他们熟知的名称。明确是王道。

    8.类名

    类名和对象名应该是名词,不应当是动词

    如 Custmer,WikiPage,Account等,避免使用Manager、Processor、Data或Info这样的类名。

    9.方法名

    方法名应当是动词或动词短语,postPayment、delegatePage、save。属性访问器加上get、set和is前缀。

    10.每个概念对应一个词

    给每个抽象概念选一个词,并且一以贯之。

    11.别用双关语

    避免将同一单词用于不同的目的。同一术语用于不同的概念,基本就是双关语了。

    12.添加有意义的语境

    很少有名称是能自我说明的--多数都不能。反之,你需要用有良好命名的类、函数或名称空间来设置名称,给读者提供语境。

    13.不要添加没用的语境

    只要短名称足够清楚,就要比长名好。别给名称添加不必要的语境。

    相关文章

      网友评论

          本文标题:一、代码整洁之道:命名

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