QUANCHANG

如何优雅的写代码

如何优雅的写代码
为什么别人的代码看起来那么优美,而我的代码就像一坨翔?

 

相信很多新人都会有这样的疑问吧,看各种框架的代码看着感(根)觉(本)特(看)别(不)溜(懂),而自己写出来的代码怎么看怎么不顺眼,为什么呢?

 

规范!!!规范!!!规范!!!

 

是的,一切都是规范问题,如果你看各种框架代码看得多了你会发现,他们好像大都是一个套路,一个说不上来的套路,看起来就很舒服,就是因为他们都有自己的一套规范,而且很多规范其实都是JCP制定或者JCP认可的规范,那么如何规范的写代码呢?下面介绍几个入门级的技巧。

 

一、善用@Override注解。@Override应该是java代码里最常见的一个注解了,对于所有继承父类的方法,都应该使用该注解标识,以便于与类自己的方法区分,同时也利于出错时的排查,将问题暴露到编译时而不是运行时,同样使用该注解的方法一般不需要写方法注释,因为是从父类继承过来的,所以需要和父类的方法功能保持一致,自然方法说明也就一致了,不需要再重新写一份了,如果你发现你的很多标记@Override的方法都必须要单独写一份注释来说明的时候就要考虑是不是代码有问题了。

 

二、善用@Deprecated注解,这个注解可能许多人接触的不多,该注解表示被注解的方法被弃用,标记该注解的方法在使用的使用在大多数IDE中会在方法调用上显示一个横线划掉方法,表示弃用,在许多框架中会看到该注解。这是由于框架升级过程中需要考虑到大多数框架使用者,保持向下兼容性,所以当API有变动时不仅要保证新API正常的使用,同样也要保证旧API正常工作,但是如果这时框架使用者仍然使用旧API怎么办?这时就可以在旧的API方法上增加该注解,告诉框架使用者这个API是一个过期即将被弃用的API,不推荐使用,如果需要使用请使用替代的新API,这时大多数框架使用者就会选择使用新的替代API了。

 

三、接上一个注解,如果使用了@Deprecated注解,那么如何告诉别人替代API呢?可能用的人会在方法说明中直接写上替代方法的名字,但是如果你有仔细看各种框架的做法时你会发现他们的好像跟你不一样,他们的方法好像是一个链接可以点击直接跳转到另一个API方法上的,而你直接写方法名则只能根据方法名一个一个的找了,效率低不说,如果方法改名字了,那么这个地方很可能会被遗漏,那么也就是说这个遗漏的地方其实已经过期了,那么那些框架是如何做到在方法说明上直接点击就可以跳到另一个方法的呢?其实很简单,只需要在写方法说明的时候使用一下写法

分类:

技术点:

相关文章: