`

转载:整理出来的一份java编码规则

    博客分类:
  • JAVA
 
阅读更多
           转载:整理出来的一份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)程序中应尽可能少使用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义。程序中需要赋值或比较时,使用前面定义的静态变量。在循环控制中例外。
分享到:
评论

相关推荐

    腾讯java编码规范

    * 换行:一行的长度超过 80 个字符需要换行,换行规则包括在一个逗号后面断开、在一个操作符前面断开、长表达式要在低优先级操作符处划分新行等。 * 间隔:类、方法及相对独立的程序块之间、变量说明之后必须加空行...

    华为JAVA编码规范.pdf

    华为JAVA编码规范.pdf 华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范,旨在提供一个统一的编程风格和代码...华为JAVA编码规范.pdf为JAVA开发者提供了一份详细的编程指南,旨在提高代码的质量和可维护性。

    Java编码规范_ICA整理版_.pdf

    Java编码规范 ICA整理版 Java编码规范 ICA整理版 Java编码规范 ICA整理版Java编码规范 ICA整理版 Java编码规范 ICA整理版 Java编码规范 ICA整理版 Java编码规范 ICA整理版 Java编码规范 ICA整理版 Java编码规范 ICA...

    tlv的java编码和解码

    1. **读取Tag**:从字节数组的起始位置读取Tag的字节,根据编码规则解析出Tag值。 2. **读取Length**:根据Tag的编码方式,解析Length字段,确定Value的字节长度。 3. **读取Value**:从字节数组中取出Length指定...

    Java编码规范&代码检查规则项.rar

    "代码检查规则项.xls"可能是一份详细的检查清单,用于自动化检查代码质量,可能包含: 1. **错误预防**:例如,未使用的变量、未关闭的资源、空指针引用等。 2. **性能优化**:检查循环优化、内存使用、过度的对象...

    编码规范 华为编码规范 JAVA 华为编码规范 JAVA

    以上仅为华为编码规范JAVA的一部分要点,实际规范包含更多细节,例如接口设计、继承与多态、并发处理等。通过遵循这些规范,开发者可以编写出更高效、可读性更强、易于维护的代码,从而提升整个项目的质量和团队协作...

    ASN.1编码规则详解(最全最经典).pdf

    PER编码规则分为两种:一种是针对固定长度数据的,另一种是针对可变长度数据的。 ##### 3.5 XML编码规则(XER) XER编码规则允许将ASN.1数据结构转换为XML格式,这使得ASN.1数据更容易被Web服务等现代应用处理。 ...

    java错误处理:java.lang.OutOfMemoryError: Java heap space

    其中,“java.lang.OutOfMemoryError: Java heap space”是一种常见的异常情况,它表明Java虚拟机(JVM)的堆内存空间已耗尽。 #### 标题和描述中的知识点详解 **标题:“java错误处理:java.lang.OutOfMemoryError:...

    Java安全编码标准_PDF电子书下载 带索引书签目录_完整版

    不仅从语言角度系统而详细地阐述java安全编码的要素、标准、规范和最佳实践,而且从架构设计的角度分析了java api存在的设计缺陷和可能存在的安全风险,以及应对的策略和措施。可以将本书作为java安全方面的工具书,...

    java和js相互base64编码解码

    这段代码首先定义了一个字符串`plainText`,然后使用`Base64.getEncoder().encode()`进行编码,编码后的结果以字节数组形式保存,再转换回字符串打印出来。接着,通过`Base64.getDecoder().decode()`对编码后的字节...

    华为java安全编码规范考试3.1.md

    华为java安全编码规范考试3.1 血与泪整理除的答案,当前时间保证是最新的,基本所有题都能找到。有几题答案没写出来,但是写了所有的错误答案…………排除法

    java开放平台源码-Bachelor-Thesis-Java-Rules:为开源平台SonarQube添加编码规则

    为开源平台SonarQube添加编码规则 学士论文 主题:应用程序漏洞测试 作者:露西亚·库库索瓦(LuciaKokuľová) 论文导师:RNDr。 朱博士Pavol Sokol博士 顾问:理学硕士。 特雷西亚·梅泽索瓦 目标: 分析应用程序...

    java动态识别文件编码EncodingDetect.java附使用方法很简单

    当我们循环遍历文件进行操作的时候可能遇到各种各样的文件编码格式,如果不知道当前循环的文件格式的话,将会遇到各种各样的问题,...使用java动态识别文件编码EncodingDetect.java这个工具类以后就变得异常简单了!

    could not create the java virtual machine 解决办法

    总之,“could not create the java virtual machine”这一错误通常是由于JVM内存配置不当导致的,通过合理地调整内存参数和优化配置文件,可以有效地避免此类问题的发生,确保Java应用的稳定运行。

    基于短信猫,采用PDU编码的短信收发java实现

    本文将详细讲解如何利用Java语言,结合PDU编码来实现基于短信猫的短信通信功能。 首先,我们需要理解PDU(Protocol Data Unit)编码。PDU编码是GSM通信系统中用于短信服务的一种二进制编码方式,它包含了短信的全部...

    JAVA字符编码:Unicode,ISO-8859-1,GBK,UTF-8编码及相互转换

    在Java编程中,字符编码的管理和转换是一项基本而又重要的任务。不同的编码标准适用于不同的场景,而理解和掌握这些编码之间的差异以及如何在它们之间进行转换,对于开发出兼容性强的应用程序至关重要。本文将详细...

    2009年最新java编码规范

    Java编码规范是软件开发中非常重要的一个环节,它旨在提高代码的可读性、可维护性和团队协作效率。2009年的Java编码规范在原有的基础上进行了精简,去除了那些繁琐且对实际开发帮助不大的规则,转而强调实用性和可...

    关联规则算法实现 java

    它有两个主要步骤:一是生成候选集,二是检查候选集的频繁性。在生成候选集的过程中,Apriori算法利用了“频繁项集的任何子集也必须是频繁的”这一先验知识,有效减少了搜索空间。在检查频繁性时,算法会扫描数据库...

Global site tag (gtag.js) - Google Analytics