java编码规范

VIP免费
2024-12-10 0 0 91KB 22 页 5.9玖币
侵权投诉
范 于程序 而言尤 重要,有以下几个原因:编码规 对 员 为
了 行 范,每个 件开 人 必 一致遵守 范——每个人。为 执 规 发 员 须 编码规
部分列出了常用的文件名及其后 。这 缀
文件类别
文件后
.java
.class
一个文件由被空行分割而成的段落以及 每个段落的可 注 共同 成。标识 选 释
若私有 和接口与一个公共 相关 ,可以将它 和公共 放入同一个源文件。 类 联
公共 必 是 个文件中的第一个 或接口。类 须 这
/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/
Java编码规
1 介(Introduction)
要有编码规范(Why Have Code Conventions)
(1) 一个 件的生命周期中,80%的花 在于 费 维护
(2) 几乎没有任何一个 件,在其整个生命周期中,均由最初的开 发 员 维护
(3) 范可以改善 件的可 性,可以 程序 尽快而 底地理解新的代 编码规 软 读 员 彻
(4) 如果你将源 布,就需要确任它是否被很好的打包并且清晰无 ,一如你已构建的其它任何 品。码 为产 发
2 文件名(File Names)
2.1 文件后(File Suffixes)
Java程序使用下列文件后 :
Java源文件
Java字 文件节码
3 文件内容 (File Organization)
2000行的程序 以 , 尽量避免。 阅读 应该 "Java源文件范例"提供了一个布局合理的Java程序范例。
3.1 Java源文件(Java Source Files)
每个Java源文件都包含一个 一的公共 或接口。单 类
Java源文件 遵循以下 还 规则
(1) 开 (参头 释 "开 注头 释")
(2) 包和引入 句(参语 见"包和引入 句")
(3) 和接口声明(参类 见" 和接口声明")
3.1.1 开 头 释(Beginning Comments)
所有的源文件都 在开 有一个应该 头 C 言 格的注 ,其中列出 名、版本信息、日期和版 声明:语 风
3.1.2 包和引入 (Package and Import Statements)
在多数Java源文件中,第一个非注 行是包 句。在它之后可以跟引入 句。例如:释 语
package java.awt;
import java.awt.peer.CanvasPeer;
注解
###
###
或接口的声明
###
###
###
例 量实 变
###
构造器
###
方法
当一个表达式无法容 在一行内 ,可以依据如下一般 断开之:纳 时 规则
以下是断开方法 用的一些例子:
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
var = someMethod1(longExpression1,
longExpression3));
以下是两个断开算 表达式的例子。前者更好,因 断开 位于括号表达式的外 , 是个 高 的断开。 为 处 这 较 级别
longName1 = longName2 * (longName3 + longName4 - longName5)
+ 4 * longname6; //PREFFER
longName1 = longName2 * (longName3 + longName4
- longName5) + 4 * longname6; //AVOID
以下是两个 方法声明的例子。缩进
3.1.3 和接口声明(Class and Interface Declarations)
下表描述了和接口声明的各个部分以及它的先后次序。参"11 Java源文件范例"中一个包含注
/接口声明的各部分
/接口文档注(/**……*/)
注 中所需包含的信息,参该 释 "文档注"
/接口 的注实现 释(/*……
*/)如果有必要的
包含任何有关整个 或接口的信息,而 些信该 释应
息又不合作为类/接口文档注 。
() 量
先是 的公共 量,后是量,后是包一类 变 护变 级别
的 量(没有 修 符访问 饰 access modifier),最后是私有
量。
先是公共 的,后是的,后是包一级别 护级别 级别
的(没有 修 符访问 饰 ),最后是私有 的。级别
些方法 按功能,而非作用,分 。例 应该 访问权 组
如,一个私有的 方法可以于两个公有的 例方法之类 实
。其的是 了更便 和理解代 。 为 阅读 码
4 排版缩进 (Indentation)
4.1 行 (Line Length)
尽量避免一行的 长 过80个字,因 很多 工具很好 理之。为 终
:用于文档中的例子 使用更的行 , 一般不超应该 长 长 70个字
4.2 (Wrapping Lines)
(1) 在一个号后断开
(2) 在一个断开
(3) 可 高选择较 级别(higher-level)的断开,而非 较 级别(lower-level)的断开
(4) 新的一行 一行同一 表达式的开应该 级别 头处对齐
(5) 如果以致你的代 混乱或者使你的代 都规则导 码 挤 边,就代之以缩进8个空格。
  someMethod2(longExpression2,
前者是常 情形,后者若使用常 的 方式将使第行和第移得靠右,所以代之以 规 缩进 缩进8个空格。
摘要:

范于程序而言尤重要,有以下几个原因:编码规对员为了行范,每个件开人必一致遵守范——每个人。为执规软发员须编码规部分列出了常用的文件名及其后。这缀文件类别文件后缀.java.class一个文件由被空行分割而成的段落以及每个段落的可注共同成。标识选释组若私有和接口与一个公共相关,可以将它和公共放入同一个源文件。类类联们类公共必是个文件中的第一个或接口。类须这类/**Classname**Versioninformation**Date**Copyrightnotice*/Java编码规范1介绍(Introduction)为什么要有编码规范(WhyHaveCodeConventions)(1)一个件...

展开>> 收起<<
java编码规范.xls

共22页,预览2页

还剩页未读, 继续阅读

声明:本站为文档C2C交易模式,即用户上传的文档直接被用户下载,本站只是中间服务平台,本站所有文档下载所得的收益归上传人(含作者)所有。玖贝云文库仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对上载内容本身不做任何修改或编辑。若文档所含内容侵犯了您的版权或隐私,请立即通知玖贝云文库,我们立即给予删除!
分类:计算机 价格:5.9玖币 属性:22 页 大小:91KB 格式:XLS 时间:2024-12-10

开通VIP享超值会员特权

  • 多端同步记录
  • 高速下载文档
  • 免费文档工具
  • 分享文档赚钱
  • 每日登录抽奖
  • 优质衍生服务
/ 22
客服
关注