`
MyEyeOfJava
  • 浏览: 1152306 次
  • 性别: Icon_minigender_1
  • 来自: 北京
博客专栏
7af2d6ca-4fe1-3e9a-be85-3f65f7120bd0
测试开发
浏览量:71174
533896eb-dd7b-3cde-b4d3-cc1ce02c1c14
晨记
浏览量:0
社区版块
存档分类
最新评论

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 编码规范-chm

    首先,命名规范是Java编码规范中的核心部分。变量名应该清晰、简洁且有意义,避免使用缩写,除非它们是业界广泛接受的标准。类名通常采用驼峰命名法,全大写字母表示常量。包名应全部小写,用点分隔各个部分。接口名...

    javabase64-1.2.jar

    综上所述,"javabase64-1.2.jar" 是一个专门处理Base64编码的Java库,它可能提供了比Java内置工具更强大的功能,包括但不限于更高的编码/解码速度、自定义编码规则或更友好的API。库内部包含元信息和测试代码,确保...

    eclipse-java-google-style-1.1/intellij-java-google-style-1.1

    标题和描述中提到的"eclipse-java-google-style-1.1"和"intellij-java-google-style-1.1"指的是Google为Eclipse和IntelliJ IDEA这两个流行的Java集成开发环境(IDE)提供的代码风格规范。这些规范是Google为了保持代码...

    Java编码规范-细则

    ### Java编码规范-细则知识点详解 #### 一、概述 Java 编码规范是一套用于指导 Java 开发者编写高质量代码的标准。它旨在通过规范化代码风格来提高代码的可读性、可维护性和可靠性。本规范由总则和细则两部分组成,...

    sonar-java-plugin-5.12.1.17771.rar

    SonarQube是一款强大的代码质量管理平台,它能够通过静态分析的方式,对源代码进行深度检查,找出潜在的质量问题、漏洞和编码规约违反情况。在软件开发过程中,SonarQube扮演着一个至关重要的角色,它帮助开发者在...

    Java文件编码转换源码

    编码是用来表示字符的规则,例如ASCII、GBK、UTF-8等。GBK是中国大陆广泛使用的汉字编码标准,它兼容GB2312并增加了更多的汉字和符号。UTF-8则是一种可变长度的Unicode编码,能表示世界上几乎所有的字符。 在Java中...

    Quoted-printable 编码介绍、Quoted-printable编码解码转换方法

    尽管Quoted-printable编码的规则相对简单,但它的编码效率和简单性使其在邮件格式中得到了广泛应用。这种编码方式确保了邮件在不同邮件系统之间传输时,即使包含非ASCII字符和二进制数据,也能够被正确地处理和显示...

    Java编码规范-细则[收集].pdf

    Java编码规范是软件开发中的重要指导原则,旨在提高代码的可读性、可维护性和团队协作效率。这份《Java编码规范-细则》是中兴通讯股份有限公司质企中心IT部制定的技术文件,版本为1.3,包含了从基础格式到高级设计...

    sonar-java-custom-rules.zip

    总结来说,"sonar-java-custom-rules.zip" 提供了一套针对Java代码的自定义SonarQube规则,可以集成到开发流程中,帮助团队遵循特定的编码规范,提升代码质量和可维护性。通过解析和使用这些规则,开发者可以更好地...

    Java编码规范-细则.pdf

    文件标题指出文档是关于Java编码规范的细则,通常这类文档会包含Java编程的格式化指南、命名约定、注释方式、代码结构设计等方面的规定。编码规范对于开发团队来说至关重要,它有助于保持代码的整洁、一致性和可维护...

    java编码规范-《The Elements of Java Style》翻译本

    《The Elements of Java Style》是一本权威的Java编码风格指南,旨在帮助开发者编写出高质量的Java代码。以下是对这本书中核心知识点的简要概括: 1. **命名规则**:在Java编程中,变量、方法和类的命名应该清晰、...

    google_checks.xml google-java编码风格 eclipse eclipse-java-google-style.xml

    google_checks.xml 谷歌编码风格 eclipse eclipse-java-google-style.xml

    eclipse-java-google-style.xml

    Google的Java编码规范覆盖了命名规则、注释规范、类与方法的设计、异常处理、类型系统等多个方面,每一个细节都经过深思熟虑,旨在促进代码的整洁和专业。 命名规则是Google风格规范的核心之一。它要求类名使用驼峰...

    eclipse-java-google-style.zip

    本文将详细解析"Eclipse Java谷歌代码规范",即通过Eclipse集成开发环境(IDE)配合谷歌制定的Java编程规范,为开发者提供一套统一的编码指南。 首先,我们要了解"Eclipse-java-google-style.zip"这个压缩包。这是...

    详谈java编码互转(application/x-www-form-urlencoded)

    Java 编码互转(application/x-www-form-urlencoded)知识点 本文将详细讲解 Java 编码互转的相关知识点,包括 URL 编码、URL 解码、application/x-www-form-urlencoded MIME 格式、UTF-8 编码机制、HTML 格式编码...

    Alibaba-Java-Coding-Guidelines-2.1.1

    该规范通常包含多个方面,如命名规范、编码风格、注释规则、异常处理、并发编程、数据库操作等。每个方面都有详细的指导和建议,以确保代码的质量和一致性。 具体来说,2.1.1 可能表示该规范的一个修订版本。随着...

    Java源代码编码规范-

    【Java源代码编码规范】 Java源代码编码规范是软件开发中的重要组成部分,它旨在提高代码的可读性、可维护性和一致性。规范的遵循能够帮助开发者更快地理解代码,减少错误,增强代码的健壮性。以下是规范的一些关键...

Global site tag (gtag.js) - Google Analytics