2019-08-20

编码规范

今天我们项目组难得有时间,一起讨论下接下来的计划,其中我提到当前项目代码质量差,不规范的问题。

作为一个Javaer,谈到代码规范,当仁不让祭出 阿里巴巴编程手册。

晚上空闲基于阿里手册整理出了适合我们的命名规范~

1. 不要使用拼音来命名,beijing alibaba youku 等国际通用名称例外。
   拼音容易引发歧义~
   getJiaGe();  getDaZhePrice(); 既不美观,也不直观。
2. 类名、方法名、变量名使用驼峰命名法。
3. 常量名全部使用大写,单词之间使用下划线分割,表达完整语义。
4. 要见其名知其意,抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类以测试的类名称开始,以Test结尾。
5. 包名统一用小写,点分隔符之间只有一个自然语义的英语单词。包名单数,类名可以使用复数。
6. 缩写要慎重,避免因为缩写导致代码可读性降低。
7. 如果模块、接口、类、方法使用了设计模式,要在命名上体现出来。
    OrderFactory LoginProxy ResourceObserver
8. Service/Dao命名规约,获取单个对象的方法get前缀;获取多个对象的方法list前缀,复数结尾;获取统计值的方法count前缀;插入方法save/insert前缀;删除方法remove/delete前缀;修改方法update前缀。
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 1.栈是一种线性结构(常见有:线性表,栈,队列等),具有先进后出的特征,也就是后进先出。 2.Java单继承,多实...
    Jennyni1122阅读 1,378评论 1 0
  • 我问了老师一个问题,我们如何让学生做打开双臂这个动作?老师的回答是,师范给学生,然后让学生再做。但是我追问,如果学...
    沐浴春风2018阅读 251评论 0 0
  • 两个人缘分的开始,是始于聊天。 那时彼此还不是很熟悉,小心翼翼的试探着彼此的心意,早安到晚安,晚安过后心意也补打烊...
    YNM解说阅读 823评论 0 2
  • 当然是奔着橙汁夫妇才看的《我们相爱吧》,之前播第一季的时候我连预告片都懒得看。 把橙汁这对CP拆解,“大仁哥”和“...
    小薇子阅读 323评论 0 0
  • 文/恰恰天蓝 人生向往和追求的莫过于两字“幸福”。 有人会说,父慈子孝那就是幸福;有人说,夫妻恩爱,相敬如宾也是幸...
    恰恰天蓝阅读 265评论 0 1