Java代书写规范.docVIP

Java代码书写规范 2003/04/15 当不得不违背本规范时，请详细注释原因 一、通用规范 1.1命名规范 使用全单词表示 使用贴切的词汇 使用大,,,,写混合 尽量少用缩略词，否则，维护一个标准的缩略词表 避免过长，,,,,于15 避免类似的命名或仅在大,,,,写上区分的命名 标准缩略词做一个单词处理 1.2文档规范 增加注释，以确保代码清晰 无需注释的程序，可能也不值得运行 避免修饰性注释 保持注释简洁 写代码之前写注释 注释中说明代码的原因，而不是结果 二、Java编码规范 2.1命名和大,,,,写规范： 下面这些广泛使用的命名规范可以应用到Java中的包、类、方法、属性和常量。因为这些规范的使用非常普遍，而且它们还影响到了我们定义的类的公共API，所以我们应该认真遵守这些规范： 包 保证包的名称是唯一的，包的名称前缀以我们的网络域名称，包名,,,,写（例如com.itsv.utils）置于文件最上一行 类 第一个字母必须大写，所以类名称是大,,,,写混合的（例如String）；如果类名称是由多个单词组成的，那么每个单词都应该以大写字母开头（例如StringBuffer）；如果一个类名称或者类名称中的一个单词是字母缩写词，那么我们可以把这个缩写词中的每个字母都写成大写（例如URL、HTMLParser）。因为设计的类是用来代表对象的，所以我们在为类起名称时应