JAVA代码规范标签： java文档工作 2016-06-12 21:50 277人阅读评论(5) 收藏

开始做java的ITOO了，近期的工作内容就是按照代码规范来改自己负责的代码，之前做机房收费系统的时候，也是经常验收的，甚至于我们上次验收的时候，老师也去了。对于我们的代码规范，老师其实是很重视的，他总说，文档和图最重要！不过我对于这句话的感触一直不太深，认为大家不太可能直接在U层直接调D层。知道我看到java的代码，没有在U层调D层，直接在B层调了底层。。。。

之前的时候，一直把代码规范代码规范当成耳旁风，觉得自己遵守就没啥问题了，现在才知道自己太天真了。因为，代码不是写来运行的，代码是写给别人看的！

下面是一些我们写代码时的规范，与大家共勉！

1. 写干净整洁的代码，请尊重空间，请尊重人眼的偏好

1.1 去除没有用到的类引用，eclipse里面Ctrl+Shilft+O。看到一大片的因为类引用没有用到而报的警告信息简直就是灾难，空间和视觉都没有得到尊重。

1.2 记得格式化代码，eclipse里面Ctrl+Shilft+F。看到一大片杂论无章，连基本的对齐都没有的代码也是很大的灾难，视觉脑力都会受到挑战。

1.3 不要吝惜废弃的老代码，eclipse里面Ctrl+D。有些人对待已经废弃的老代码比对待自己的老婆还宝贝，大量运用注释来保留，随着代码的演变暂用非常大量的空间。如果那段代码非常精妙，舍不得删，那么请把它移到您的私人代码库。

1.4 请不要写冗余无用的代码。if(true)之类的代码块完全不应该出现，用空行隔开该段代码是更好的选择。

1.5 请合理运用空行。空行可以用来隔开相对独立的代码块，有利于阅读和理解。但是不要使用超过一行的空行，对空间，别太奢侈了。

1.6 请不要在两个地方出现完全相同的代码，您总是可以想办法重用的，不是吗？

1.7 命名类，方法，变量慎用简写，除非大家都公认。全称我都不一定看得懂，简称您太高估我的智商了！请问qrbs代表什么，可能火星人知道吧！

1.8 把所有的类变量放到最前面，如果比较多请按用途分组排列，不要把变量散落在大江南北，我找的真的很辛苦！

1.9 拆分大的类，大的方法，如果您的类有一万行，如果您的方法有一千行，我真的会恐惧，是恐惧！

2. 高效运用注释

2.1 规范的注释类信息。请查看一下Java标准库的String.java源码吧，包括文件名，日期，作者，版本号等信息，用统一的模板。千万别把您的大名散落于方法签名甚至于具体代码里面了。我在读业务逻辑的时候没有兴趣思考您的人生！要找您我可以在类签名里面找到的，放心啊！

2.2 非Java Bean的public方法都需要注释，您总不会要别人读您的代码才能调用您的代码吧！即便您的英文非常好，命名也非常规范，您总不能期待别人都英文好，理解都一样吧。

2.3 为不容易理解类变量注释。类变量特别是私有的类变量没有人要求注释，但是为了能够快速的了解您表示的是什么，还是写点什么吧！您知道我英文不算好！

2.4 注释代码段，注释逻辑选择。上面提到运用空行分割开逻辑相对独立的代码，那么请在空行的下一行也写点下面代码段要干什么的语句吧。如果有if else等逻辑选择的时候，麻烦也花几秒钟写上判断的依据和结果好吗？逻辑难懂且关键，您懂的！