【从零开始学Java】———— 2、Java编码规范

1.命名规范

包名：包名是全小写字母，中间由点号分隔。如java.awt.event、com.hexin.plait类和接口名：采用大驼峰，如SplitViewController文件名：采用大驼峰，如Helloword.java变量名：采用小驼峰，如crossSite常量名：全大写，可以由下划线分隔，如APACHE_TOMCAT_VERSION方法名：采用小驼峰，如balanceAccount

2.注释规范

Java语言中有三种注释：单行注释、多行注释、文档注释

单行注释（//）多行注释（/…/）文档注释（/**…*）

文档注释

文档注释能够生成API帮助文档，JDK中javadoc命令能够提取这些注释信息并生成HTML文件。文档注视主要对类（接口）、实例变量、静态变量、实例方法和静态方法进行注释。

文档注释标签

标签描述@author说明类或接口的作者@deprecated说明类或成员已经废弃@param说明方法参数@return说明返回值@see参考另一个主题的链接@exception说明方法所抛出的异常类@throws与@exception同@version类或接口的版本

使用javadoc生成API帮助文档

javadoc -d apidoc HelloWorld.java

程序会创建一个apidoc目录，其中的index.html文件是文档的入口。