`

转载:整理出来的一份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编码规则.pdf

    Java编码规则.pdf Java编码规则.pdf是AmbySoft Inc....Java编码规则.pdf是一份非常实用的白皮书,为Java开发者提供了详细的编码规范和指南,以帮助他们编写高质量的代码,提高开发效率和团队协作效率。

    腾讯java编码规范

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

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

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

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

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

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

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

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

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

    华为java编码规范模板

    华为Java编码规范模板包含了命名规则、注释规范、代码结构等多个方面的指导原则,涵盖了类、方法、变量的命名,异常处理,空值检查,日志记录等多个方面,旨在打造高质量的Java代码。 Eclipse是一款强大的Java集成...

    Java编码规范

    为使开发项目中所有的JAVA程序代码的风格保持一致,增加代码的可读性,便于维护及内部交流,使JAVA程序开发人员养成良好的编码习惯,有必要对JAVA程序的代码编码风格做统一的规范约束。本文档定义了我公司软件开发...

    哈夫曼编码实现压缩解压缩java

    哈夫曼编码是一种高效的数据编码方法,主要用于无损数据压缩,尤其在文本文件的压缩中表现出色。这种编码方式基于频率最小的字符用最短的二进制代码表示的原理,能够有效地减少数据存储和传输时的位数,从而达到压缩...

    Java源码:比较经典的一些Java源代码,适合于初学者

    2. **类与对象**:Java是一种面向对象的语言,理解和运用类和对象是关键。学习如何创建类,定义属性和方法,以及如何实例化对象,理解构造函数的作用和对象间的继承关系。 3. **封装、继承和多态**:这被称为面向...

    阿里JAVA编码规范使用文档1

    阿里JAVA编码规范使用文档1是针对企业内部编程工作的一份重要指导文件,旨在提供一套统一的编码标准,以便于开发团队在项目开发过程中遵循一致的风格和规则,减少因编码风格不一致产生的沟通成本和潜在错误。...

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

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

    could not create the java virtual machine 解决办法

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

    Delphi和JAVA进行TCPIP通信(用UTF-8编码)例子

    最近的项目(Delphi开发),需要经常和java语言开发的系统进行数据交互(Socket通信方式),数据编码约定采用UTF-8编码。 令我无语的是:JAVA系统那边反映说,Delphi发的数据他们收到是乱码,而我这边(Delphi7,...

    如何使用Java代码获取文件、文件流或字符串的编码方式.zip

    本工程用于研究如何使用Java代码获取文件、文件流或字符串的编码方式 本工程编码方式:UTF-8 开发工具:MyEclipse 参考博客:http://blog.csdn.net/gaohuanjie/article/details/43735891

    Java做的Unicode编码转换器

    Java编写的Unicode编码转换器是一种实用工具,它能够帮助用户将各种国家和地区的文字转换成Unicode编码,同时也能实现从Unicode编码回转到原始字符。Unicode是一种国际标准,旨在为全球所有的字符提供一个统一的编码...

    Java十大基础笔记整理(PDF)

    Java是世界上最流行的编程语言之一,尤其在企业级应用开发中占据主导地位。这份"Java十大基础笔记整理(PDF)"提供了全面的Java...这份"Java学习笔记"涵盖了这些核心概念,对于Java新手来说,是一份宝贵的参考资料。

    如何使用Java代码将GBK编码格式的工程转换为UTF-8编码格式的工程.zip

    3. **转换编码**:对于检测到GBK编码的文件,使用`java.nio.file.Files`类的`readAllBytes`和`write`方法,配合`java.nio.charset.StandardCharsets`中的`UTF_8`常量,将文件内容从GBK编码转换为UTF-8编码。...

    java.io.CharConversionException: isHexDigit处理

    Java.io.CharConversionException: isHexDigit 是 Java 中一种常见的异常,通常发生在传输数据时编码不正确或 URL 传值时出现问题。本文将对该异常进行详细分析,介绍导致该异常的原因和解决方法。 一、问题描述 ...

    FindBugs规则整理_中文版

    ### FindBugs规则整理知识点详解 #### FindBugs概述 FindBugs是一款开源的静态代码分析工具,主要用于Java应用程序的缺陷检测。通过分析程序的字节码,FindBags能够帮助开发者发现潜在的问题,提高软件的质量和安全...

Global site tag (gtag.js) - Google Analytics