Java中的命名规范和注释

驼峰法则

驼峰法则法则分为两种

• 小驼峰法则：第一个单词首字母小写，其他单词首字母大写，例如：javaStudy
• 大驼峰法则：所有单词的首字母大写。例如：JavaStudy

java命名规范

• 项目名：全部小写
• 包名：全部小写
• 类、接口名：大驼峰法则，每个单词第一个字母大写
• 方法名：小驼峰法则
• 变量名：小驼峰法则
• 常量：所有单词的所有字母大写
  不建议使用拼音命名

注释

代码注释

• 单行注释： 在要注释的代码前书写// 例如

  //注释内容

• 多行注释： 在需要注释的代码前书写 例如

  /**
  * 注释内容
  *
  */

文档注释

• 类注释

  /**
  * @author  类创建者姓名
  * @date    创建日期
  * @version 版本
  * @description 类的描述
  */

• 方法注释

  /**
  * @author 作者
  * @date 创建日期
  * @param 参数说明，可以有多个
  * @return 返回结果的说明
  * @throws 异常类型.错误代码 注明从此方法中抛出异常的说明
  * @description 方法的详细介绍
  */

• 属性注释

  /**名字*/
  private String name;