Java代码规范文档

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)}

时间: 2024-10-07 19:55:49

Java代码规范文档的相关文章

【转载】WEB前端开发规范文档

本文转载自谈笑涧<WEB前端开发规范文档> 为 新项目写的一份规范文档, 分享给大家. 我想前端开发过程中, 无论是团队开发, 还是单兵做站, 有一份开发文档做规范, 对开发工作都是很有益的. 本文档由本人编写, 部分意见来源于网络, 以此感谢, 片面及有误的地方, 希望大家指正. 另, 本文档部分规范是为我所在项目组所写, 使用时请根据实际项目需求修改.以下为[WEB前端开发规范文档]正文点此查看WEB版本 规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量

WEB前端开发规范文档

规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度. 文件规范 1. html, css, js, images文件均归档至约定的目录中;

开发备必:WEB前端开发规范文档

为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必 须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改. 基本准则 符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的 解析速度. 文件规范 1. html, css, js, images文件均归档至<系统开发规范>约

超详细Web前端开发规范文档

规范目的为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档, 特制订此文档. 本规范文档一经确认, 前端开发人员必须按本文档规范进行前台页面开发. 本文档如有不对或者不合适的地方请及时提出, 经讨论决定后方可更改.基本准则符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.文件规范1. html, css, js, images文件均归档至<系统开发规范>约定的

【转】Web前端开发规范文档

规范目的: 使开发流程更加规范化. 通用规范: TAB键用两个空格代替(WINDOWS下TAB键占四个空格,LINUX下TAB键占八个空格). CSS样式属性或者JAVASCRIPT代码后加“;”方便压缩工具“断句”. 文件内容编码均统一为UTF-8. CSS.JAVASCRIPT中的非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示. 文件规范: 文件名用英文单词,多个单词用驼峰命名法. 一些浏览器会将含有这些词的作为广告拦截:ad.ads.adv.banner.spo

规范文档

宗旨:提高合作和代码质量,不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. ? 针对 HTML5 doctype 排版规则 缩进 1个TAB=4个空格 - 所有的代码都用小写字母 行尾空格没必要存在 HTML 不要在自闭合(self-closing)元素的尾部添加斜线 -- HTML5 规范中明确说明这是可选的.常见无需自闭合标签有 input.br.img.hr 等. 在HTML模板和文件中指定编码 <meta charset="utf-8"> ,

前端开发规范文档

  目的 提高团队协作效率,方便前后端功能添加和后期优化及维护. 一,通用规范 1.Tab键用4个空格代替(windows下Tab键占4个空格): 2.统一文档编码为"UTF-8",统一文档类型为<!DOCTYPE html>,统一收藏夹图标,统一字体; 3.禁止在js/json中使用关键字命名: 4.if.while.when.switch语句的执行体用"{}"括起来,禁止省略花括号: 5.禁止在return关键字及要返回的表达式之间换行: 6.必须为

(转)详解PHP编码规范文档

使用驼峰结构命名,即以小写字母开头,从第二个单词开始,每个单词的第一个字母大写. 大半天时间整理的PHP编码规范- 一.命名规范: 1. 常量的命名 1) 字母,全部大写,使用"_" 分隔单词. 如:DEFINE("PHP_DEMO_PRINT","hEllo world"); 2. 变量的命名 1) 使用驼峰结构命名,即以小写字母开头,从第二个单词开始,每个单词的第一个字母大写. 如:$getElement="myodbc"

【html】页面制作规范文档

每天都在写html/css/js代码,总结的一些页面制作的规范 文件命名规范 1) 文件目录.文件名称统一用小写的英文字母.数字.下划线组合,文件名要与表现的内容相近,不到万不得已不要以拼音作为名称,如 登录页面:login.html(不要用 denglu.html). 2) 目录结构规范:清晰的站点目录结构方便文件的维护和整理,同时对增加搜索引擎的友好度和移植也有着重要的影响. 图片制作规范 1) 如果图片作为内容放在html代码里,则必须定义它的宽度和高度. 2) 如果图片不包含任何信息,仅