1 / 30
文档名称:

编码规范.docx

格式:docx   大小:43KB   页数:30页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

编码规范.docx

上传人:世界末末日 2022/7/3 文件大小:43 KB

下载得到文件列表

编码规范.docx

相关文档

文档介绍

文档介绍:Java 语言编码规范(Java
Code Conventions)
目录
介绍(Introduction) 4
为什么要有编码规范(Why Have Code Conventions) 4
版权声明(Ackno人员必须一致遵守编码规范。
版权声明(Acknowledgments)
本文档反映的是 Sun MicroSystems 公司,Java 语言规范中的编码标准部分。主要贡献者包括:Peter King,Patrick Naughton,Mike DeMoney,Jonni Kanerva, Kathy Walrath以及 Scott Hommel。
本文档现由 Scott Hommel 维护,有关评论意见请发至 ******@
文件名(File Names)
这部分列出了常用的文件名及其后缀。
文件后缀(File Suffixes)
Java 程序使用下列文件后缀:
文件类别
Java 源文件
文件后缀
.java
Java 字节码文件 .class
常用文件名(Common File Names) 常用的文件名包括:
文件名
用途
GNUmakefile makefiles 的首选文件名。我们采用 gnumake 来创建(build)软
README
件。
概述特定目录下所含内容的文件的首选文件名
文件组织(File Organization)
一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过 2000 行的程序难以阅读,应该尽量避免。"Java 源文件范例"提供了一个布局合理的 Java 程序范例。
Java 源文件(Java Source Files)
每个 Java 源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联,可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。
Java 源文件还遵循以下规则:
开头注释(参见"开头注释")
包和引入语句(参见"包和引入语句")
类和接口声明(参见"类和接口声明")
开头注释(Beginning Comments)
所有的源文件都应该在开头有一个 C 语言风格的注释,其中列出类名、版本信息、日期和版权声明:
/*
Classname
*
Version information
*
Date
*
Copyright notice
*/
包和引入语句(Package and Import Statements)
在多数 Java 源文件中,第一个非注释行是包语句。在它之后可以跟引入语句。例如:
package ;
import ;
类和接口声明(Class and Interface Declarations)
下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见"Java 源文件范例"中一个包含注释的例子。
类/ 接口声明的各部分
类 / 接 口 文 档 注 释
(/**……*/)
类或接口的声明
类/ 接口实现的注释
3 (/*……*/)如果有必要的话
类的(静态)变量
实例变量
构造器
方法
注解
该注释中所需包含的信息,参见"文档注释"
该注释应包含任何有关整个类或接口的信息,而这些信息又不适合作为类/接口文档注释。
首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。
首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。
这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。
缩进排版(Indentation)
4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格vs. 制表符)。一个制表符等于 8 个空格(而非 4 个)。
行长度(Line Length)
尽量避免一行的长度超过 80 个字符,因为很多终端和工具不能很好处理之。注意:用于文档中的例子应该使用更短的行长,长度一般不超过70 个字符。
换行(Wrapping Lines)
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:
在一个逗号后面断开
在一个操作符前面断开
宁可选择较高级别(higher-

最近更新

2025年物流企业信息化论文(共13篇) 57页

2025年物业公司客服部工作职责(精选篇) 12页

2025年爷爷作文900字(推荐29篇) 52页

2025年父与子的“战争”作文(推荐篇) 17页

2025年爱的传递作文750字(共24篇) 35页

海工装备:挑战与机遇-技术创新驱动未来发展 23页

2025年爆-逯俺- 让人无言以对(精选5篇) 17页

智慧物业,新篇章-科技领航物业管理新纪元 31页

2025年激励自己的座右铭集绵(集锦3篇) 15页

2025年漫漫古典情(共7篇) 16页

2025年满月酒通知怎么写(锦集篇) 9页

2025年温馨幽默周末问候短信(精选篇) 12页

提升银行服务品质-礼仪引领,客户满意度提升 24页

2025年清明节烈士陵园一年级话题作文350字(共.. 13页

2025年清明扫墓二年级周记(共篇) 13页

2025年海澜之家新的体会(共5篇) 12页

2025年浅谈小学英语的有效教学(通用篇) 34页

2025年浅浅的月光作文(精选24篇) 28页

2025年流星的使命小学生一年级作文(集锦24篇.. 13页

2025年泰戈尔的超经典语录(通用篇) 46页

2025年泛酸钙片说明书(通用8篇) 17页

2025年法学专业个人简历表(合集篇) 14页

盐城志愿填报规划方案 27页

国家新生儿先天性心脏病筛查项目技术规范 7页

《二甲双胍临床应用专家共识(2023年版》要点 18页

2022年04月广东广州市中医医院招聘笔试(第一.. 188页

《平行四边形的认识》的教学设计 7页

独胆金尊(新排易读版) 60页

常用金属材料的焊接及工艺课件 30页

第一讲教育学(教育硕士) 63页