阿里巴巴Java开发手册学习笔记

1. 注释规范

• 类、属性、方法注释：必须使用Javadoc规范，格式为/*内容/，避免使用//。
• 抽象方法注释：除了参数、返回值、异常外，还需说明功能。
• 类创建信息：必须添加创建者和创建日期，格式为@date yyyy/MM/dd。
• 方法内部注释：单行注释使用//，多行注释使用/* */。
• 枚举类型注释：每个字段必须有注释说明用途。
• 中文注释：推荐使用中文注释，专有名词和关键字保持英文。
• 注释更新：代码修改时，注释也应相应更新。
• 未使用代码：推荐删除未使用的字段、方法、参数和变量。
• 注释掉的代码：应详细说明原因，如果无用则删除。

2. 特殊注释标记

• TODO：标记待实现的功能，包括标记人、时间和预计处理时间。
• FIXME：标记错误且不能工作的代码，需要及时纠正。

3. 其他注意事项

• 正则表达式：使用预编译功能以加快匹配速度。
• Apache BeanUtils：避免使用，性能较差，可使用Spring BeanUtils或Cglib BeanCopier。
• Velocity模板：直接使用属性名取值，自动调用POJO的getXxx()或isXxx()方法。
• 页面变量：后台输送给页面的变量必须加!，如!var。
• Math.random()：注意返回类型为double，取值范围0≤x<1。
• 视图模板：避免加入复杂逻辑，遵循MVC理论。
• 数据结构初始化：指定大小，避免无限增长。
• 清理代码：及时清理不再使用的代码段或配置信息。