关于命名规则
- 由于Java面向对象编程的特性, 在命名时应尽量选择名词
- 驼峰命名法（Camel-Case）: 当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
- 如：myFirstName
包名的书写规范 （Package）
-
选择有意义的名字，能快速地传达该类的用途。
-
所有包的命名必须采用小写英文字母。
- 例如：net.vschool
-
应用系统中经常应用分层，
- Dao层（数据库访问）
- Service层（业务处理）
- Web层（页面控制action类）。
-
包名的前几个为固定名称, 如果是网站的话，采用网站的域名的反写，如果域名还没有确定的话，采用公司固定的几个名称。
- 如：net.vschool
-
在包名的接下来一个单词为模块的名称。如：用户模块，包名为net.vschool.user，关于模块的访问操作，采用分层形式,一般分为：
- Dao层操作：一般定义在net.vschool.xxx.dao 中，其中xxx为模块名称。
- Service层操作：一般定义在net.vschool.xxx.servie中。
- web层操作：一般定义在 net.vschool.xxx.action中。
- 如下关于用户模块的例子：
- net.vschool.user
- net.vschool.user.dao
- net.vschool.user.action
- net.vschool.user.service
类名的书写规范 (Class)
- 选择有意义的名字，能快速地传达该类的用途。
- 参照java驼峰命名法，类名的首字母必须采用大写的形式，如果类名为多词组合而成的话，那么每个词的首字母必须采用大写。
- 如：StudentAnswer.java
- 当要区别接口类和实现类的时候，可以在类的后面加上“Impl”。
- 如：接口类：UserInterface.java 接口实现类：UserInterfaceImp
- 推荐实体类没有后缀名。
变量的命名
-
选择有意义的名字，能快速地传达该变量的用途。
-
参照java驼峰命名法，首字母以小写开头，每个单词首字母大写（第一个单词除外）。
-
变量命名采用基本结构为：typeVariableName，使用3字符前缀来表示数据类型。
-
例如，定义一个整形变量：intDocCount，其中int表明数据类型，后面为表意的英文名，每个单词首字母大写。
-
数据类型或对象类型 变量前缀 备注 byte bye 1、做数组用时，再加前缀-a,如字符串数组：astr， char chr 2、自定义类型的变量可以采用本身的名称，把首字母改为小写。 float flt 3、采用名称要能代表在方法中的意义。如果员工列表：employeeList boolean bln Integer/int int' short sht Long/long lng Double/double dbl String str
使用技巧
- 在一段函数中不使用同一个变量表示前后意义不同的两个数值。
- 除非是在循环中，否则一般不推荐使用单个字母作为变量名，i、j、k等只作为小型循环的循环索引变量。
- 避免用Flag来命名状态变量。
- 用Is来命名逻辑变量，如：blnFileIsFound。通过这种给布尔变量肯定形式的命名方式，使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。
- 如果需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，如果在代码的某些区域中使用intCnt，而在另一些区域中又使用intCount，就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。
静态变量
- 选择有意义的名字，能快速地传达该变量的用途。
- 参照java驼峰命名法，采用全部大写的形式来书写，对于采用多词合成的变量采用“_”来连接各单词。
- 如：USER_LIST
方法命名
- 方法表示一种行为，它代表一种动作，最好是一个动词或者动词词组或者第一个单词为一个动词。
- 属性方法：以get/set开头，其后跟字段名称，字段名称首字母大写。
- 如：getUserName()
- 数据层方法：只能以insert（插入）,delete（删除）,update（更新）,select（查找）,count（统计）开头，其他层方法避免以这个5个单词开头，以免造成误解。
- 服务层方法，根据方法的行为命名，只描述方法的意义，而不采用方法的目的命名。比如系统的添加新用户，用户可以前台注册，也可以管理员后台添加，方法会被重用，所以最好不要用使用register，采用add会更好写。避免使用与web层相关的方法。
- Web层方法最好是贴近web的语言，如register，login，logout等方法。
Javadoc
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author wey |
| @deprecatede | 指明一个过期类或成员 | @deprecatede description |
| {@docRoot} | 指明当前文档目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| @inheritDoc | 直接从父类继承的注释 | Inherits a comment from the immediate superClass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另外一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField 组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |