Java代码规范文档

简介:  NOTE:以下部分为一个简要的编码规范,更多规范请参考 ORACLE官方文档。  地址:http://www.oracle.com/technetwork/java/codeconventions-150003.pdf  另外,请使用 UTF-8格式来查看代码,避免出现中文乱码。

 NOTE:以下部分为一个简要的编码规范,更多规范请参考 ORACLE 官方文档。

  地址:http://www.oracle.com/technetwork/java/codeconventions-150003.pdf

  另外,请使用 UTF-8 格式来查看代码,避免出现中文乱码。

  

至于注释应该使用中文还是英文,请自己行决定,根据公司或项目的要求而定,推荐使用英文。

    1. 整理代码

      1.1. Java 代码中不允许出现在警告,无法消除的警告要用 @SuppressWarnings

     1.2. 去掉无用的包、方法、变量等,减少僵尸代码。

     1.3. 使用 Lint 工具来查看并消除警告和错误。

     1.4. 使用 Ctrl+Shift+F 来格式化代码,然后再进行调整。

     1.5. 使用 Ctrl+Shift+O 来格式化 Import 包。

  2. 命名规则

     2.1. 基本原则 

          2.1.1. 变量,方法,类命名要表义,严格禁止使用 name1, name2 等命名。

          2.1.2. 命名不能太长,适当使用简写或缩写。(最好不要超过 25 个字母)

          2.1.3. 方法名以小写字母开始,以后每个单词首字母大写。

          2.1.4. 避免使用相似或者仅在大小写上有区别的名字。

          2.1.5. 避免使用数字,但可用 2 代替 to,用 4 代替 for 等,如go2Clean。  

 

     2.2. 类、接口

    

          2.2.1. 所有单词首字母都大写。使用能确切反应该类、接口含义、功能等的词。一般采用名词。

          2.2.2. 接口带 I 前缀,或able, ible,er等后缀。如ISeriable。

    

    

     2.3. 字段、常量

    

          2.3.1. 成员变量以 m 开头,静态变量以 s 开头,如 mUserName, sInstance。

          2.3.2. 常量全部大写,在词与词之前用下划线连接,如 MAX_NUMBER

          2.3.3. 代码中禁止使用硬编码,把一些数字或字符串定义成常用量。

          2.3.4. 对于废弃不用的函数,为了保持兼容性,通常添加 @Deprecated,如 {@link #doSomething()}

    

         

  3. 注释

     请参考 {@link #SampleCode}类的注释。

    

     3.1. 常量注释,参见 {@link #ACTION_MAIN}

     3.2. 变量注释,参见 {@link #mObject0}

     3.3. 函数注释,参见 {@link #doSomething(int,float, String)}

     

    

  4. Class 内部顺序和逻辑

 

     4.1. 每个 class 都应该按照一定的逻辑结构来排列基成员变量、方法、内部类等,

              从而达到良好的可读性。

     4.2. 总体上来说,要按照先 public, 后protected, 最后 private, 函数的排布

              也应该有一个逻辑的先后顺序,由重到轻。

     4.3. 以下顺序可供参考:

          定义TAG,一般为 private(可选)

          定义 public 常量

          定义 protected 常量、内部类

          定义 private 变量

          定义 public 方法

          定义 protected 方法

          定义 private 方法

         

 

  5. 表达式与语句

     5.1. 基本原则:采用紧凑型风格来编写代码

     5.2. 细则

    

          5.2.1. 条件表示式,参见 {@link #conditionFun(boolean)}

          5.2.2. switch 语句,参见 {@link #switchFun(int)}

          5.2.3. 循环语句,参见 {@link#circulationFun(boolean)}

          5.2.4. 错误与异常,参见 {@link #exceptionFun()}

          5.2.5. 杂项,参见 {@link #otherFun()}

          5.2.6. 批注,参见 {@link #doSomething(int,float, String)}

      

目录
相关文章
|
5天前
|
运维 Java
Java版HIS系统 云HIS系统 云HIS源码 结构简洁、代码规范易阅读
云HIS系统分为两个大的系统,一个是基层卫生健康云综合管理系统,另一个是基层卫生健康云业务系统。基层卫生健康云综合管理系统由运营商、开发商和监管机构使用,用来进行运营管理、运维管理和综合监管。基层卫生健康云业务系统由基层医院使用,用来支撑医院各类业务运转。
27 5
|
6天前
|
JavaScript Java 测试技术
基于Java的电影评论系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的电影评论系统的设计与实现(源码+lw+部署文档+讲解等)
21 0
|
6天前
|
JavaScript Java 测试技术
基于Java的在线日语培训平台的设计与实现(源码+lw+部署文档+讲解等)
基于Java的在线日语培训平台的设计与实现(源码+lw+部署文档+讲解等)
23 0
|
6天前
|
JavaScript Java 测试技术
基于Java的同城蔬菜配送管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的同城蔬菜配送管理系统的设计与实现(源码+lw+部署文档+讲解等)
11 0
|
6天前
|
JavaScript Java 测试技术
基于Java的心理预约咨询管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的心理预约咨询管理系统的设计与实现(源码+lw+部署文档+讲解等)
22 0
基于Java的心理预约咨询管理系统的设计与实现(源码+lw+部署文档+讲解等)
|
6天前
|
JavaScript Java 测试技术
基于Java的税务门户网站的设计与实现(源码+lw+部署文档+讲解等)
基于Java的税务门户网站的设计与实现(源码+lw+部署文档+讲解等)
5 0
|
6天前
|
JavaScript Java 测试技术
基于Java的高校毕业生就业管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的高校毕业生就业管理系统的设计与实现(源码+lw+部署文档+讲解等)
22 0
基于Java的高校毕业生就业管理系统的设计与实现(源码+lw+部署文档+讲解等)
|
6天前
|
JavaScript Java 测试技术
基于Java的家纺用品销售管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的家纺用品销售管理系统的设计与实现(源码+lw+部署文档+讲解等)
17 0
|
6天前
|
JavaScript Java 测试技术
基于Java的教务管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的教务管理系统的设计与实现(源码+lw+部署文档+讲解等)
20 0
|
6天前
|
JavaScript Java 测试技术
基于Java的西安旅游管理系统的设计与实现(源码+lw+部署文档+讲解等)
基于Java的西安旅游管理系统的设计与实现(源码+lw+部署文档+讲解等)
18 0