开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养

       最近一段时间,每天忙于各种业务,都没有自己的时间写一些东西,昨天看到阿里今天发布 《Java 开发手册》泰山版,结合自己现在开发实际的情况,不得不写吐槽一下现在的开发问题,先看看目前的代码 

    这个还好,有时间 ,作者,虽然没有写描述和打印日志信息

开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养_第1张图片

这个没有时间 作者 注释 ,日志信息也没有,接收参数是个map (虽然说也没啥问题)

开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养_第2张图片

     我们再看看接口的返回参数,因为返回没有用实体接口,返回的是个 list 这里都是全大写, 小朋友,你是否有很多问号?????? 

开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养_第3张图片

 这种大部分是不想写实体,但是实体不是都可以根据数据库自动生成吗,可能有的东西写的早,属于历史遗留问题,还有的就是大家都这样写,自己也照葫芦画瓢,然后整个风格就是这样,但是我们还是要从自身规范自己,跟业界的风格统一,比如RESTful 方法注解,类注释 ,方法内注释,尽量详细,前人栽树后人乘凉,你看别人的代码一行注释没有你心里也在骂,

/**
 * @version V1.0
 * @author: hqk
 * @date: 2020/4/20 10:48
 * @Description: 这个类是干嘛的
 */

代码注释也是一样,进入的时候打印一下,执行完毕打印一下,中间不打印也行,但是写好注释,这样查日志排查问题的时候可以快速定位 ,返回的参数,大家都可以使用 idea 的一款插件,自动生成驼峰格式的实体带注释 (虽然自己之前也是没注释没注解也是一步步规范过来的,尽量变的规范 )

idea还有一个阿里巴巴规范的插件,也可以安装一下,检查下代码规范,防止有一些写法会出问题

开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养_第4张图片

今天也是有感也发,虽然大部分和自身处在的开发大环境有关,但是还是需要从自身规范自己,《Java 开发手册》泰山版今天也发布,有空可以研读一下,增加下自身的规范

开发规范的重要性 致敬《Java 开发手册》泰山版,程序员的自我修养_第5张图片

你可能感兴趣的:(工作感悟)