JAVA代码规范

简介: JAVA代码规范

开始做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等逻辑选择的时候,麻烦也花几秒钟写上判断的依据和结果好吗?逻辑难懂且关键,您懂的!


目录
相关文章
|
1月前
|
运维 Java
Java版HIS系统 云HIS系统 云HIS源码 结构简洁、代码规范易阅读
云HIS系统分为两个大的系统,一个是基层卫生健康云综合管理系统,另一个是基层卫生健康云业务系统。基层卫生健康云综合管理系统由运营商、开发商和监管机构使用,用来进行运营管理、运维管理和综合监管。基层卫生健康云业务系统由基层医院使用,用来支撑医院各类业务运转。
50 5
|
9月前
|
SQL 安全 Java
Java阿里巴巴代码规范
Java阿里巴巴代码规范
12677 0
|
9月前
|
算法 安全 Java
Java代码规范的重要性
Java代码规范的重要性
195 0
|
设计模式 安全 Java
编码20年, Java代码规范全部奉上
写代码就像写文章, 好的代码就像好的文章,结构严谨,构思清晰。写代码就像写文章, 一不留神就成流水账,为避免这种情况作为软件开发工程师,重要的是设计而不是实现。 **在一个团队中,由于不同经验的开发导致编程风格可能会出现非常混乱的情况,从而导致开发成本上升。难以维护。所以代码规范就显得异常重要了。** 本篇文章就是给出编程命名的建议,仅供参考,但是其目的是为了统一规范,提高编程能力,降低开发成本,减少代码维护成本。 契约精神: 做到有法可依,有章可循
1311 4
|
Dubbo NoSQL Java
【自省】使用Executors.xxx违反阿里Java代码规范,那还不写定时任务了?
【自省】使用Executors.xxx违反阿里Java代码规范,那还不写定时任务了?
117 0
【自省】使用Executors.xxx违反阿里Java代码规范,那还不写定时任务了?
|
IDE 前端开发 Java
【代码规范】Java程序员的编程笔记(培养好习惯)
分享优秀的Java编程好习惯!欢迎打卡学习!
150 0
【代码规范】Java程序员的编程笔记(培养好习惯)
|
Java 应用服务中间件 BI
阿里官方Java代码规范标准解析 - 基本数据类型与包装数据类型的使用标准
阿里官方Java代码规范标准解析 - 基本数据类型与包装数据类型的使用标准
941 0
|
存储 监控 安全
Java代码规范
一、前言 本文参考《阿里巴巴Java开发手册》,这本书主要定义了一些代码的规范以及一些注意事项。我只根据我自己的不足,摘录了一些内容,方便以后查阅。  二、读书笔记 命名 1、代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
1273 0