课程咨询 :18487146383

长沙Java培训 > 达内新闻 > 你需要知道的代码命名原则
  • 你需要知道的代码命名原则

    发布:长沙Java培训      来源:netsmell.com      时间:2016-09-07

  • 代码有个好名字,一个能够简洁、能够清晰表达概念和意图的名字非常重要。那么如何给代码命名呢,以下由达内长沙java培训分享的代码命名原则你需要知道。

    1、使用可读的名字

    避免过度使用缩写

    可读的名字交流方便

    猜一猜下面的类是干什么的?和别人怎么说这几个类?

    根据这些简直变态的缩写,如果没有注释基本上很难知道是干什么的,当你和别人交流的时候,你就不得不一个一个字母来念“X-L-Q-Y”、“L- T-Q Manager”,鬼知道你说的是什么?PS. XLQY-XianLvQiYuan(仙履奇缘), LTQ-LiaoTianQun(聊天群),有这样的名字也是醉了。

    BAD:

    class XLQY;

    class FCNV;

    class LTQManager;

    2、使用可搜索的名字

    避免使用Magic Number

    避免使用单字母,或出现频率极高的短字母组合(注意度的把握)

    BAD:

    if (obj->base->id == 4661) // 4661是啥玩意?

    {

    usetype = Cmd::XXXXXXX;

    }

    int e; // 怎么查找?

    XXXX:iterator it; // 变量作用的范围比较大的时候,也不见得是个好名字

    GOOD:

    #define OJBECT_FEEDBACK_CARD 4661

    if (OJBECT_FEEDBACK_CARD == obj->base->id)

    {

    usetype = Cmd::XXXXXXX;

    }

    3、避免使用编码”

    匈牙利标记法:

    Windows API时代留下的玩意

    形如:wdXX, dwXXX, strXXX

    类型变换导致名不副实,就有可能出现明明是个DWORD,变量名却是qwNum。

    PS.匈牙利命名对于我们这些在Linux下摸爬滚打的好多年的来说,看着真心别扭。

    成员前缀:

    形如:m_name, m_xxx

    基本上都无视,为何要多次一举

    PS.说到这一点,可能有些同学有不同意见了,“我这样写是为了区分成员变量和临时变量啊!”,好像这样写也没什么大不了,遵循代码规范即可。如Google的C++代码规范,私有变量形如:xxx_,加后缀_,其目的除了让你知道这货是个私有变量,还有一点就是防止有些人图省事把带私有变量直接public掉,因为谁也不喜欢在代码里面看到大量这些带把的玩意。

    接口和实现:

    接口名形如:IXXX, I-接口修饰前缀

    类名形如:CXXX, C-类修饰前缀

    这些修饰多数时候都是废话

    4、名字尽量来自解决方案领域或问题领域

    使用解决方案领域名称:

    写代码的同学多数都是都出自CS,术语、算法名、模式名、数学术语尽管用。如AccountVisitor:Visitor模式实现的Account类。

    使用问题领域的名称

    我们代码里面多数都是这些名称,不明白找策划问问,基本上都是功能相关的名称。

上一篇:给你的代码取个好名字很重要

下一篇:你需要 else 吗?

最新开班日期  |  更多

Java--大数据业余制班

Java--大数据业余制班

开班日期:4月28日

Java--大数据全日制班

Java--大数据全日制班

开班日期:4月28日

Java--零基础业余班

Java--零基础业余班

开班日期:4月28日

Java--零基础全日制班

Java--零基础全日制班

开班日期:4月28日

  • 网址:http://cs.java.tedu.cn     地址:长沙市开福区芙蓉中路一段 476 号建鸿达现代城 9 楼
  • 课程培训电话:18487146383     全国服务监督电话:400-111-8989
  • 服务邮箱 ts@tedu.cn
  • 2001-2016 达内时代科技集团有限公司 版权所有 京ICP证8000853号-56