- 1、本文档共53页,可阅读全部内容。
- 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
- 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
查看更多
Java 语言编码规范(Java Code Conventions)
译者 晨光(Morning)
搜集整理 :华竹技术实验室
简介 :
本文档讲述了 Java 语言的编码规范,较之陈世忠先生《c++编码规范》的浩繁详尽,此文当属
短小精悍了。而其中所列之各项条款,从编码风格,到注意事项,不单只 Java,对于其他语言,
也都很有借鉴意义。因为简短,所以易记,大家不妨将此作为 handbook,常备案头,逐一对
验。
声明:
如需复制、传播,请附上本声明,谢谢。
原文出处:/docs/codeconv/html/CodeConvTOC.doc.html,
译文出处:/,moyingzz@
目录
1 介绍
• 1.1 为什么要有编码规范
• 1.2 版权声明
2 文件名
• 2.1 文件后缀
• 2.2 常用文件名
3 文件组织
• 3.1 Java源文件
o 3.1.1 开头注释
o 3.1.2 包和引入语句
o 3.1.3 类和接口声明
4 缩进排版
• 4.1 行长度
• 4.2 换行
5 注释
• 5.1 实现注释的格式
o 5.1.1 块注释
o 5.1.2 单行注释
o 5.1.3 尾端注释
o 5.1.4 行末注释
• 5.2 文挡注释
6 声明
• 6.1 每行声明变量的数量
• 6.2 初始化
• 6.3 布局
• 6.4 类和接口的声明
7 语句
• 7.1 简单语句
• 7.2 复合语句
• 7.3 返回语句
• 7.4 if,if-else,if else-if else语句
• 7.5 for语句
• 7.6 while语句
• 7.7 do-while语句
• 7.8 switch语句
• 7.9 try-catch语句
8 空白
• 8.1 空行
• 8.2 空格
9 命名规范
10 编程惯例
• 10.1 提供对实例以及类变量的访问控制
• 10.2 引用类变量和类方法
• 10.3 常量
• 10.4 变量赋值
• 10.5 其它惯例
o 10.5.1 圆括号
o 10.5.2 返回值
o 10.5.3 条件运算符?前的表达式?前的表达式
o 10.5.4 特殊注释
11 代码范例
• 11.1 Java源文件范例
1 介绍(Introduction)
1.1 为什么要有编码规范(Why Have Code Conventions)
编码规范对于程序员而言尤为重要,有以下几个原因:
- 一个软件的生命周期中,80%的花费在于维护
- 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护
- 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码
- 如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的
其它任何产品
为了执行规范,每个软件开发人员必须一致遵守编码规范。每个人。
1.2 版权声明(Acknowledgments)
本文档反映的是 Sun MicroSystems 公司,Java 语言规范中的编码标准部分。主要贡献者包
括:Peter King,Patrick Naughton,Mike DeMoney,Jonni Kanerva,Kathy Walrath
以及 Scott Hommel。
本文档现由 Scott Hommel 维护,有关评论意见请发至 shommel@
2 文件名(File Names)
这部分列出了常用的文件名及其后缀。
2.1 文件后缀(File Suffixes)
Java 程序使用下列文件后缀:
文件类别 文件后缀
Java 源文件 .java
文档评论(0)