JAVA语言编码规范讲述.ppt

Java语言程序设计规范 邓伟林 williamten@163.com 本章总体纲要 编程规范 文档注释 Java编程风格的指导方针 指导方针是可以被打破，但要求是确实所需要的，例如增加可读性 没有标准可以做到完美无缺，也没有标准可以做到适用于所有的应用 指导方针一般是为了: 增加可读性、程序的可理解性，从而提高程序的可维护性以及程序代码质量 命名规范 良好的命名规范可以增强程序的可读性 可以给标识符提供功能/属性上的一些额外信息—例如: 是否是常量、类、包等。这些信息对理解程序非常有帮助 问题? 命名规范应当包含哪些内容? 命名规范内容 包 文件 类/接口 方法 变量 常量 包的命名规范 包的名称一般全部采用小写 包名的前缀一般是域名单词序列的逆序 示例 com.sun.eng com.apple.quicktime edu.cmu.cs.bovik.cheese 文件的命名规范 Java源程序文件的命名规范 必须与该文件中public类的类名同名 后缀必须是 .java 类/接口的命名规范 类名一般是名词/名词词组: 每个单词的首字母大写，其它字母小写 类名应当尽量简单，而且其含义能够尽量准确地刻画该类的含义 一般采用全称—尽量少用缩写词 (除非该缩写词被广泛使用) 示例 J_Clock J_Circle Time ImageSprite (图版精灵) 方法的命名规范 方法名一般是/ 动词/动词性词组, 首字母小写 中间单词的首字母大写，其它字母小写 示例: run( ); getBackground( ); getTime( ); 尽量应用常用词 尽量应用简单的、常用的单词 示例: get/set first/last add/remove up/down create/destroy min/max start/stop next/previous insert/delete old/new increment/decrement open/close old/new show/hide begin/end 变量的命名规范 变量名的首字母小写 中间单词的首字母大写，其它字母小写 变量名的首字母尽量不要用字符: _ 或 $ 变量名应当简短、有含义、且便于记忆 示例: int i; char c; double widthBox; 变量的命名规范 变量名常常由表示其所扮演的角色与数据类型组成 示例: Point startingPoint, centerPoint; Name loginName; 常量的命名规范 常量名一般全大写，单词之间用下划线分隔 (“_”) 示例: static final int MIN_WIDTH = 4; static final int MAX_WIDTH = 999; 编辑方法 特殊字符 行数/每行的字符数 缩排方式(Indentation) 空白符/行 语句书写——关键 保证代码的简单性 文件组织 源程序文件一般采用如下的组织顺序: 最开始一般是注释 package 和 import 语句 类和接口的定义 本章总体纲要 编程规范 文档注释 javadoc Javadoc 是一种从文档注释生成HTML帮助文件的工具 文档注释介于 /** 和 */ 之间 示例 /** Sorts integer array using emMySort/em algorithm */ 文档注释的一般格式 示例: /** * This is the description part of a doc comment * * @tag Comment for the tag */ 常用的 javadoc 文档标签 @author @param @return @see 运行 javadoc 在命令行下执行: javadoc options packages sources options : 选项列表 packages : 包列表 sources : 源文件列表 示例: javadoc -d . -author Time3.java * * @throws @deprecated @link @since @version * *