java编码规范
一、注释
1.分类:注释分实现注释和文档注释两类
实现注释--为/* */和//格式,有块、单行、尾端、行末四种注释方式,在局部变量进行注释
文档注释--为/** */格式,在包、类、接口、方法、类变量、实例变量前进行注释
2.规则:用中文描述,注释量50%以上,与代码同步,明确注释的含义,在关键代码、复杂代码、分支语句要进行注释
3.避免:缩写,特殊字符,在代码中写注释
二、语句
1.简单语句:每行至多一个简单语句,例如定义字符变量:String str = "A";
2.返回语句:return语句一般不用小括号,除非能明确表示含义,例如:return (A>2?true:false)
3.switch中若没有Break要添加注释
三、换行
1.行长度一般不要超过80个字,不超过120字也可以接受,最好不要影响阅读性
2.在一个逗号后面断开,在一个操作符前面断开
3.新的一行应该与上一行同一级别表达式的开头处对齐
4.if语句括号内的换行通常使用2个TAB的规则,因为常规缩进(1个TAB)会使语句体看起来比较费劲
四、空白
1.空行规则:(1).方法间,(2).变量和方法间,(3).方法逻辑间
2.空格规则:(1).关键字与()之间,(2).参数列表逗号后,(3).除.之外的二元操作符加空格,(4).for语句分号后
3.缩进规则:类中成分,方法体或语句块的成分,换行后非起始行---一般在上一级成分的基础上加一个缩进
五、命名规范
1.包名:小写
2.类名/接口:每个单词首字母大写,使用完整单词拼接
3.方法:首字母小写,其他拼接的单词首字母大写
4.变量:不能以下划线和美元符号开头,实例名、类常量等与方法规则一致,变量名应简短
5.常量:全部大写,并且每个字母间以下划线隔开
六、编程习惯
1.实例或类变量一般私有,公有的时候一般是作为数据结构
2.访问一个类的静态属性,一般是用该类直接引用
3.除-1、0、1外的数字一般要用常量来标识它的意思
4.同一个语句中避免给多个变量赋值
5.在一个运算的表达式中要用圆括号来表达运算的优先级,容易看懂
七、编码规则
1.数据库及时关闭,多个IO要关闭,都要用try-catch
2.捕获到异常若不处理,则要用日志进行打印,自己抛出异常要明确异常含义
3.运算时用括号明确表示运算的优先级
4.声明数组用int[] index,经过了一个强转的过程,可读性差
5.不用system.out打印,同一用日志打印
6.集合必须指定类型
7.一个文件不要定义两个类
8.条件语句不要用==号来判断
9.尽量不要强转
10.异常:不要抛出过多异常,异常要明确分类
八、性能可靠
1.数组复制使用System.arraycopy(*)
2.不要使用循环将集合转为数组,可以使用集合的toArray()方法
3.大量字符串的相加等于处理应该使用StringBuffer
4.对类中日志工具对象logger应声明为static
九、SSH相关规则
1.命名规则:接口要以大写字母I开头(或者实现类要以Impl结尾)并放在impl目录下
2.以该类文件结尾:Action,Controller,Service,Dao
3.注解声明Sprng的bean:@Controller-Action(Controller),@Service-Service,@Repository-DAO,@Component-其他
4.注解方式声明Spring的bean时,要定义bean的名字为常量
5.一个Action类的方法中,只调用一次Service类:(1)避免掉用多个事务的时候没有办法回滚所有事务,(2)一个业务逻辑应在一个Service里完成,可以在Service中调用其他Service
6.跟数据库相关的SQL应放入Dao层
分享到:
相关推荐
阿里巴巴java编码规范 ,Java 并发编程培训(阿里巴巴) 《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大...
华为JAVA编码规范.pdf 华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范,旨在提供一个统一的编程风格和代码组织方式,以提高代码的可读性、维护性和可重用性。该规范涵盖了编程语言的基本结构、命名规则...
Java 编码规范 Java 编码规范是指在 Java 语言中编写代码时需要遵守的一些约定和规则,以确保代码的可读性、可维护性和可扩展性。本文将对 Java 编码规范的主要内容进行详细讲解。 命名风格是 Java 编码规范的重要...
腾讯 Java 编码规范 腾讯 Java 编码规范是腾讯集团管理标准的一部分,旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、...
"java编码规范考试题答案" 一、Java编码规范考试题答案 本文档涵盖了Java编码规范的各种方面,包括集合类、线程、对称密码算法、异常处理、命名规范、随机数生成、压缩文件解压、安全编程规范、操作系统登录用户名...
JAVA编码规范是软件开发中不可或缺的一部分,它不仅有助于提高代码的可读性和可维护性,还能促进团队协作,减少潜在的编程错误。以下是从给定的文件信息中提炼出的关键知识点,涵盖了JAVA编码规范的基本原则、文件...
**百度Java编码规范** 在软件开发中,遵循一定的编码规范是非常重要的,它能提高代码的可读性,便于团队协作,降低维护成本。百度作为一家技术驱动的公司,也提出了其内部使用的Java编码规范,旨在确保代码的一致性...
Java编码规范是软件开发中非常重要的一个环节,它旨在提高代码质量、可读性、可维护性和团队协作效率。这份文档,"Java编码规范.doc",由东软集团有限公司的商用软件事业部编写,包含了国内大型Java项目和国际知名...
Java、编码规范、Java编码规范、阿里巴巴、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里...
Java编码规范是编程实践中至关重要的指导原则,它旨在提高代码的可读性、可维护性和团队协作效率。本文档详细阐述了Java编程时应遵循的一些关键规则和最佳实践。 1. **简介** - **目的**:制定这些规范的主要目的...
1. **命名约定**:Java编码规范对变量、方法、类和包的命名有明确的要求。例如,类名应采用驼峰式命名法,每个单词首字母大写;方法名和变量名则使用小驼峰式,首个单词全小写;常量全大写,单词间用下划线分隔。包...
本压缩包“java编码规范.zip”提供了华为版的编码规范和一个详细的Java代码规范版本,旨在帮助开发者遵循一致的规则,编写出易于阅读、维护的高质量代码。 首先,我们来看华为版的Java编码规范。华为作为全球知名的...
【公司Java编码规范】是确保团队协作和代码质量的重要文档,它定义了开发人员在编写Java代码时应遵循的一系列规则和最佳实践。这些规范旨在提高代码可读性、可维护性和可扩展性,减少错误,并使代码更容易理解和调试...
Java编码规范(Java Coding Standard) oiNSFT-BS-OT0105 V3.0 2005-5-11 东软集团有限公司 商用软件事业部 版权所有 中国 沈阳浑南高新技术产业开发区 东软软件园
Java编码规范是编程实践中的一项重要准则,它有助于提高代码的可读性、可维护性和团队间的协作效率。以下是对标题和描述中所述知识点的详细解释: 1. **命名规范** - **标识符规则**:标识符由ASCII字母、数字和...