zoukankan      html  css  js  c++  java
  • 代码整洁之道--有意义的命名

    以下是我需要改进的地方,仅用以提醒自己,还有一些现在还没有很好的体会

    1、变量、函数、类的名称要能告诉你它是做什么的

    int d; //消逝的时间     不能说明变量名的意思
    int daySinceModification;

    2、避免误导,避免使用相似度很高的变量

    var songListLi = document.createElement("li");
    var songListLiSpan = document.createElement("span");
    var songListLiSpanInput = document.createElement("input");

    这里变量的命名也没有实际的含义

    3、使用读得出来的名称,标识符名称写完整,别写个缩写就了事,没找到好的范例,平常有类似这样写过,disComment(差) disPlayComment

    4、每个概念对应一个词,给多个类中的同种类型的方法命名,要统一命名

    (getComment  queryComment  disPlayComment  showcomment),所有同种类型的方法只采用其中一种方式

    5、去掉多余的描叙

    nameString都知道名字是字符串还有必要在后面加String来多此一举吗

    6、使用可搜索的名称,单字母名称和数字很难在项目中搜索出来,若变量或常量在代码中多处使用,应当赋予其便于搜索的名称

    7、不使用前缀后缀,接口声明别以I开头告诉别人这是个接口,宁愿在实现类的后面加Imp

    8、避免使用单字母变量

    int a, b, c;(不好)
    除了循环的时候常用已成标准的for(int i ....) j k

    9、类名 、对象名都应该是名词或名词短语。方法名都应该是动词或动词短语

  • 相关阅读:
    POJ 2175 Evacuation Plan 费用流 负圈定理
    POJ 2983 Is the Information Reliable? 差分约束
    codeforces 420B Online Meeting
    POJ 3181 Dollar Dayz DP
    POJ Ant Counting DP
    POJ 1742 Coins DP 01背包
    中国儒学史
    产品思维30讲
    Java多线程编程核心技术
    编写高质量代码:改善Java程序的151个建议
  • 原文地址:https://www.cnblogs.com/dengmj/p/4858519.html
Copyright © 2011-2022 走看看