zoukankan      html  css  js  c++  java
  • 代码整洁之道

    一.有意义的命名

      1、名副其实

      2、避免误导

        避免留下掩藏代码本意的错误线索,避免实用与本意相悖的词,例如别用accountList作为一组数据名称,除非数据真的是一List集合。

      3、有意义的命名

        不用i和数字1组合作为变量名,数字0或字母o作为变量名等,

      4、做有意义的区分

        函数参数不实用(a1,a2...)作为形参数名,如实用function(String sorce, String destination),variable永远都不要出现在变量中

      5、实用读的出来的名称

        命名实用简单,易读,易懂的单词

      6、实用可收索的名称

        如查询方法以getXXX,findXXX,方法名称的长短应该与其作用域的长短相对应。

      7、避免使用编码

        如实用字母+数字,PhoneNumber  phoneString  //类型变化时名称并没有变

      8、不使用成员前缀

        应当把类名和函数做的足够小,消除使用成员前缀,如:m_XXX

      9、接口和实现类的命名

        java接口名不提倡以I字母开头,

      10、避免思维映射

        一般在作用域小的变量用i或j,作为变量,避免实用数字1,出现错。

      11、类名或对象

        类名和对象名应该是名词或名词短语,如:Customer,Account,避免实用Message,Info这样的类名,类名不应当是动词。

      12.方法名

        方法名应该实用动词或动词短语,如:deletePage,SaveXXX。

      13.别扮可爱

        如使用whack()来表示kill(),实用eatMyShorts()这类与文化相关的笑话取代abort();

      14、每个概念对应一个词

        避免实用get,find,fetch多个命名定义查询方法,可以对于查询同一使用getXXX

      15、别用双关语

        如多个类都用addXXX方法,其中一个是通过增加或连接已有的值获取新值,然后放到新的集合中,这种应该使用appendXXX之类词命名更加贴切。

      16、使用领域名称

        尽量使用计算机术语,算法名,模式名,显我咱们更专业,是吧!

      17、使用源自所所涉及领域的名称

        使用所涉及领域更贴近代码,所以使用源自问题领域的名称。

      18、适当的添加语境

        如第一个数使用firstNum,第二个数使用secondNum

    二、函数

      19、

     

        

  • 相关阅读:
    Python模块进阶、标准库、扩展库
    python垃圾回收机制
    VMWare workstation 安装 CentOS 8后自适应调整分辨率(如1920x1080)
    使用 Zeal 打造属于自己的文档
    Erlang 开发者的福音:IntelliJ IDEA 的 Erlang 插件
    Intellij IDEA 14的注册码
    在Intellij IDEA或者PhpStorm下用X-debug调试PHP
    PHPCMS 核心代码与 www 分离部署
    PHPCMS如何实现后台访问限制?
    推荐:PHPCMS v9 安全防范教程!
  • 原文地址:https://www.cnblogs.com/ablejava/p/5547950.html
Copyright © 2011-2022 走看看