原创力文档- 1、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。。
- 2、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 4、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 5、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
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 Java字节码文件 .class
2.2 常用文件名（Common File Names）
常用的文件名包含：
文件名 用处 GNUmakefile makefiles的首选文件名。我们采取gnumake来创建（build）软件。 README 概述特定目次下所含内容的文件的首选文件名
3 文件组织（File Organization）
一个文件由被空行分别而成的段落以及标识每个段落的可选注释共同构成。跨越2000行的法度难以浏览，应当尽量避免。Java源文件典范供给了一个布局公道的Java法度典范。
3.1 Java源文件（Java Source Files）
每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相接洽关系，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
Java源文件还遵守以下规矩：
开首注释（拜见开首注释）
包和引入语句（拜见包和引入语句）
类和接口声明（拜见类和接口声明）
3.1.1 开首注释（Beginning Comments）
所有的源文件都应当在开首有一个C说话风格的注释，此中列出类名、版本信息、日期和版权声明：
/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/
??????? ?
3.1.2 包和引入语句（Package and Import Statements）
在多半Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：
package java.awt;
import java.awt.peer.CanvasPeer;
??????? ?
3.1.3 类和接口声明（Class and Interface Declarations）
下表描述了类和接口声明的各个项目组以及它们呈现的先后次序。拜见Java源文件典范中一个包含注释的例子。
? 类/接口声明的各项目组 注解 1 类/接口文档注释（/**……*/） 该注释中所需包含的信息，拜见文档注释 2 类或接口的声明 ? 3 类/接话柄现的注释（/*……*/）若是有须要的话 该注释应包含任何有关全部类或接口的信息，而这些信息又不合适作为类/接口文档注释。 4 类的（静态）变量 起首是类的公共变量，随后是保护变量，再后是包一级此外变量（没有接见润饰符，access modifier），最后是私有变量。 5 实例变量 起首是公共级此外，随后是保护级此外，再后是包一级此外（没有接见润饰符），最后是私有级此外。 6 机关器 ? 7 办法 这些办法应当按功能，而非感化域或接见权限，分组。例如，一个私有的类办法可以置于两个公有的实例办法之间。其目标是为了更便于浏览和懂得代码。
4 缩进排版（Indentation）
4个空格常被作为缩进排版的一个单位。缩进的确切申明并未具体指定（空格 vs. 制表符）。一个制表符便是8个空格（而非4个）。
4.1 行长度（Line Length）
尽量避免一行的长度跨越80个字符，因为很多终端和对象不克不及很益处理惩罚之。
重视：用于文档中的例子应当应用更短的行长，长度一般不跨越70个字符。
4.2 换行（Wrapping Lines）
当一个表达式无法容纳在一行内时，可以根据如下一般规矩断开之：
?在一个逗号后面断开
?在一个操纵符前面断开
?
文档评论（0）