java总结：代码规范

主要来自：

• https://blog.csdn.net/mengxiangsun/article/details/79020226
• https://www.cnblogs.com/xiaocai0923/p/10698824.html

命名规范

• 所有的标示符都只能用ASCⅡ字母（A-Z或a-z）、数字（0-9）和下划线“_”。
• 一个唯一包名的前缀总是全部小写的字母。例如：www.tonysun.cc
• 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。例如：Tony。
• 接口的大小写规则与类名相似：例如：Tony。
• 方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。例如：setNeekeName(String neekeName)。
• 变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短且可以顾名思义，易于记忆。例如：neekeName、neekeAddress。避免单个字符的变量名，除非是一次性的临时变量。
• 常量的声明应该全部大写，每个单词之间用“_”连接。例如：final String WWW_TONY_CN = “www.tonysun.cc”;

注释规范

javaDoc

• 表明类、域和方法等的意义和用法等的注释，要以javadoc的方式来写

  /**
   * [method] 初始化数据
   * @param databaseName {String} 数据库名称
   * @exception IllegalArgumentException
   * @return {boolean} 是否成功
   */

块级别注释

/*----------start: 订单处理 ------- */
//取得dao
OrderDao dao = Factory.getDao("OrderDao");

/* 查询订单 */
Order order = dao.findById(456);

//更新订单
order.setUserName("uu");
order.setPassword("pass");
order.setPrice("ddd");

orderDao.save(order);
/*----------end: 订单处理 ------- */