自己整理的一套java编码规则,让自己写代码不会那么乱

1.命名规范

(1)所有的标示符都只能用ASCⅡ字母(A-Z或a-z)、数字(0-9)和下划线“_”。

(2)类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。例如:UserInfo

(3)接口的大小写规则与类名相似:例如:UserInterface。

(4)方法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。例如:setName(String name)。

(5)变量名采取驼峰式命名,第一个字母小写,任何中间单词的首字母大写。变量名应简短且可以顾名思义,易于记忆。类的成员变量(自动生成的Mapper类除外,都用小写m开头)。

(6)常量的声明应该全部大写,每个单词之间用“_”连接。例如:final String FTP = "FTP://192.168.1.2";

2.注释规范

(1)注释尽可能使用“//”;对于所有的javadoc的注释则使用“/*”;

(2)所有的源文件都在开头有一个注释,列出作者和时间,用Myeclipse的模板即可。

(3)每个方法必须添加注释(类的main()方法除外)。

(4)每个属性必须添加注释。

(5)代码中至少包含15%的注释。Js代码应该超过30%的注释。

(6)注释使用中文。

3.缩进排版规范

(1)避免一行的长度超过60个字符。

(2)使用Eclipse的源代码的格式化功能完成代码的缩进排版。

4.文件名规范

(1)一个Java源文件只能存储一个Java类。

(2)文件名与Java类名相同。

(3)一个类文件的代码行不超过200行。

5.声明规范

(1)一行声明一个变量。

(2)不要将不同类型变量的声明放在同一行。

(3)只在代码块的开始处声明变量。

(4)所有的变量必须在声明时初始化。

(5)避免声明的局部变量覆盖上一级声明的变量。

(6)方法与方法之间以空行分隔。

6.语句规范

(1)每行至少包含一条简单语句。

(2)在return语句中,返回值不使用小括号“()”括起来。

(3)if语句总是用“{”和“}”括起来。每个“{“或者”}“ 都单独占用一行。

(4)在for语句的初始化或更新子句中,避免因使用三个以上变量,而导致复杂度提高。

(5)当switch的一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注释。

7.编程规范

(1)提供对实例以及类变量的public或private访问控制,尽可能不适用默认值或protected访问控制。

(2)避免用一个对象访问一个类的静态变量或方法。应该用类名代替。

(3)避免在一个语句中给多个变量赋相同的值。

(4)用switch()语句实现多路分支。

(5)如果使用JDBC,则考虑使用java.sql.PreparedStatement,而不是java.sql.Statement。

(6)用于设置对象状态的方法前缀必须是set;用于检索一个布尔类型对象状态的方法前缀必须是is,而用于检索其他方法前缀必须是get。

(7)程序中应尽可能少使用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义。程序中需要赋值或比较时,使用前面定义的静态变量。在循环控制中例外。

时间: 2024-10-17 09:10:12

自己整理的一套java编码规则,让自己写代码不会那么乱的相关文章

个人整理--Java编码规范

编码规范对于开发人员来说是非常重要的,有以下几个原因: 1.一个软件的生命周期中,80%的花费在于维护 2.几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护 3.编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码 4.如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品 5.为来自不同的项目组或个人提供标准的代码格式. 6.增加易读性. 在不用Java两年多后因工作需要我又要转入Java开发,为此我整理出下面的编码规范,

这是一套Java菜鸟到大牛的学习路线之高级教程,由工作了10年的资深Java架构师整理。

这是一套Java菜鸟到大牛的学习路线之高级教程,由工作了10年的资深Java架构师整理.        01-java高级架构师设计-基础深入        J2SE深入讲解        Java多线程与并发库高级应用视频教程下载        java反射机制        java设计模式视频        数据结构视频教程        Eclipse视频教程.zip        MyEclipse视频教程.zip    02-java高级架构师设计-JavaEE拓展        A

UTF-8编码规则(转)

UTF-8是Unicode的一种实现方式,也就是它的字节结构有特殊要求,所以我们说一个汉字的范围是0X4E00到0x9FA5,是指unicode值,至于放在utf-8的编码里去就是由三个字节来组织,所以可以看出unicode是给出一个字符的范围,定义了这个字是码值是多少,至于具体的实现方式可以有多种多样来实现. UTF-8是一种变长字节编码方式.对于某一个字符的UTF-8编码,如果只有一个字节则其最高二进制位为0:如果是多字节,其第一个字节从最高位开始,连续的二进制位值为1的个数决定了其编码的位

WEB前端 [编码] 规则浅析

前言 说到前端安全问题,首先想到的无疑是XSS(Cross Site Scripting,即跨站脚本),其主要发生在目标网站中目标用户的浏览器层面上,当用户浏览器渲染整个HTML文档的过程中出现了不被预期的脚本指令并执行时,XSS就会发生.XSS有三类: 反射型XSS:发出请求时,XSS代码出现在URL中,作为输入提交到服务端,服务端解析后响应,在响应内容中出现这段XSS代码,最后浏览器解析执行,此过程就像一次反射: 存储型XSS:它与反射型XSS的差别仅在于--提交的XSS代码会存储在服务端,

CheckStyle,定制自己的Java编码规范

前言 一.CheckStyle简介 Checkstyle是一个开发工具,可以帮助程序员编写遵循编码标准的Java代码.它自动化了检查Java代码的过程,以避免人类完成这一枯燥(但很重要)的任务.这使得它非常适合那些希望实施编码标准的项目.Checkstyle是高度可配置的,可以支持几乎任何编码标准,默认内置Sun Java编码规范和Google Java编码规范两套配置文件,我们也可以根据自己的需要配置自己的规范. 二.CheckStyle的安装 与其它的插件一样,CheckStyle插件也提供

关于Java编码

ASCII:用7位编码将英文字符和一些常用的符号存诸为从0到127的数值. Unicode:Unicode用一个2字节数字表示每个字符,从0到65535.每个 2 字节数字表示至少在一种世界语言中使用的一个唯一字符.(在多种语言中都使用的字符具有相同的数字码.)这样就确保每个字符一个数字,并且每个数字一个字符.Unicode数据永远不会模棱两可.Unicode使用相同的数字表示ASCII和ISO-8859-1中的字符.只是这两种编码用一个字节表示,而Unicode用两个字节表示.所以Unicod

Java编码与乱码问题

一.为什么要编码? 由于人类的语言太多,因而表示这些语言的符号太多,无法用计算机的一个基本的存储单元----byte来表示,因而必须要经过拆分或一些翻译工作,才能让计算机能理解. byte一个字节即8个bit,所以能表示的字符范围是0~255个,这满足不了人类的需要,要解决这个矛盾必须需要一个新的数据结构char,从char到byte必须经过编码. 二.常用编码介绍 ASCII码 总共128个,用一个字节的低7位表示,0~31是控制字符,如换行.回车.删除等,32~126是打印字符,可以通过键盘

15套java互联网架构师、高并发、集群、负载均衡、高可用、数据库设计、缓存、性能优化、大型分布式 项目实战视频教程

* { font-family: "Microsoft YaHei" !important } h1 { color: #FF0 } 15套java架构师.集群.高可用.高可扩 展.高性能.高并发.性能优化.Spring boot.Redis.ActiveMQ.Nginx.Mycat.Netty.Jvm大型分布 式项目实战视频教程 视频课程包含: 高级Java架构师包含:Spring boot.Spring  cloud.Dubbo.Redis.ActiveMQ.Nginx.Mycat

java编码过滤器

1.java编码过滤器的作用: java过滤器能够对目标资源的请求和响应进行截取,过滤信息执行的优先级高于servlet. 它新增加的功能包括:1. 应用程序生命周期事件控制;2. 新的国际化;3. 澄清了类的装载规则;4. 新的错误及安全属性;5. 不赞成使用HttpUtils 类;6. 各种有用的方法;7. 阐明并扩展了几个servlet DTD;8. filter功能. 2.java过滤器的使用: (1)编写一个普通的java类,实现Filter接口 import java.io.IOEx