天天看点

编码不规范很危险在eclipse中:Help->Install New Software结语:

最近的IT圈不是很太平,前有程序员与产品经理决战紫禁之巅,后有删库跑路一说,又来了一个编码不规范被祭天。作为一个程序员不单单要有强健的体魄更要有刀枪不入的神功,要不然这是拿生命在编程啊。说起编程规范不得不提《阿里巴巴Java开发手册》。以前这份手册发布出来的时候有下载下来看过,从中受益匪浅。那个时候也只是粗略的看了一遍,并没有仔细的去阅读和体会。毕竟自己还是个菜鸟需要继续努力,决定再去看一遍。在此还要感谢同事的不杀之恩。

编码不规范很危险在eclipse中:Help->Install New Software结语:

 这本手册的涉及面很多,有编程规约,异常日志,单元测试,数据库等。对于程序员来说编程规约是决定了你是否会被祭天的决定因素重要原因。个人总结如下:

一、命名的风格 

我国传统文化中,人的起名,本身就是作为一种文化行为,是有着一定的内涵的文化现象。取一个好名字,可以提现出不同的文化印象。有些名字气血轩昂,不同凡响;有些名字精明干练;有的名字给人感觉多才多艺;有的给人一种才华横溢的感觉;如果代码只写给计算机看的,那么你喜欢使用“随缘命名法”也没人在意,但是我们写出来的代码更多的时候是给人看的,所以我们的命名就需要让别人一看就知道你写的是什么,你写的东西能实现什么。代码的bug是必然存在的,好的命名风格可以给看你代码的人省下很多时间,给你填坑也快一些。对此我总结了以下:

  • 通用:代码中的命名不能以数字,下划线,美元符号开头或是以下划线,美元符号结尾
  • 禁止中西合璧命名法,随缘命名法;命名要有意义;缩写语义要清晰
  • 包:包名统一用小写,单词不可用复数
  • 类:单词首字母大写风格;抽象类以Abstract开头;测试类名以Test结尾;异常以Exception结尾
  • 使用设计模式类名以对应模式结尾;Service与Dao接口实现类以Impl结尾;枚举类以Enum结尾
  • 方法:方法名采用驼峰命名法;测试方法以test开头;使用设计模式方法名以对应模式结尾;
  • 变量:常量名或枚举成员名称全部大写,单词间采用下划线分割;数组定义类型括号要紧挨
  • service/dao层方法前缀名称:插入用insert/save;删除用delete/remove;修改用update;获取数据用get;获取列表用list

二、做到高内聚,低耦合

耦合性与内聚性是模块独立性的两个定性标准,将软件系统划分模块时,尽量做到高内聚低耦合,提高模块的独立性,为设计高质量的软件结构奠定基础。通俗来说,高内聚:就像是你作为一个开发人员你就负责开发对应的功能,而不用去管开发完的软件测试工作,测试有对应的测试人员去做。职责分明,功能单一便是高内聚。低耦合:就像是笔记本脱离了键盘,笔记本依旧能正常的使用,它们之间就是低耦合。当你在修改bug的时候,你需要阅读有几千行代码的方法的时候你就会发现如果写这段代码的人那个时候遵循高内聚,低耦合,把功能封装起来,那么对于阅读代码的人来说是一个多么幸福的事情。做好自己也是在帮助他人

三、代码注释

刚开始编程的时候觉得写注释不是那么重要,反正代码只有自己看,但是出来工作之后就会发现,注释可以很大程度的提高代码的可读性,快速的了解代码的功能,理解里面代码逻辑。Java中的注释有两种,多行注释:,多行注释也被称为javadoc注释;单行注释://;

总结如下:

  • 单行注释:使用在被注释语句上方另起一行,使用//注释
  • 多行注释:类,类属性,类方法必须采用多行注释
  • 所有类必须要被注释上对应的创建者和创建日期
  • 方法必须注释方法做什么事情,实现什么功能
  • 多行注释好处:不进入类/方法即可悬浮提示对应的注释信息;可以生成对应的API文档

四、其他

  • 在使用equals的时候,必须要把不为空的值放在左边,把可能为空的值放在左边为报空指针;
  • 方法有注解的时候必须要添加对应的注解;
  • 不使用过时的方法;

五、要学会使用工具,来规范我们的代码,Eclipse 安装阿里巴巴代码规范插件

在eclipse中:Help->Install New Software

点击-》add

名称输入:随意都ok

url:https://p3c.alibaba.com/plugin/eclipse/update

编码不规范很危险在eclipse中:Help->Install New Software结语:

 点击ok选择对应的插件同意协议安装即可,安装之后需要重启。PS:JDK最好1.8

结语:

谁都可以编程,现在的程序员基本上是零门槛,只要你从网络上载点教学视频,学习个三个月就能上路了。车开上路难免有点飘,作为一个程序猿,你能写的出让电脑看的懂的程序不是能耐,最重要的是要写出能让人看的懂的程序才是能耐。话是这样说,但是又有几个人能够做的到呢?我们只有不断的去学习,去实践。《阿里巴巴Java开发手册》是能让我我们码出高效的一本书,值得一读。做好自己也是在帮助他人。《阿里巴巴Java开发手册》下载地址:http://techforum-img.cn-hangzhou.oss-pub.aliyun-inc.com/1528269849853/Java_manual.pdf

喜欢的朋友可以关注我的微信公众号:PS:有许多关于编程的资源免费分享

编码不规范很危险在eclipse中:Help->Install New Software结语:

继续阅读