下面是基本的代码注释惯例：
1，增加注释应该使得代码更加明了；
2，如果程序不值得注释，那么程序可能会不值得运行；
3，避免华丽辞藻，不要用标语式语句；
4，保持注释尽量简单；
5，在写代码前写注释；
6，注释主要说明为什么要做某事，而不是如何做；
注释有三种类型的注释方式：
| 注释类型 | 用法 | 示例 |
| javadoc注释 | 在类、接口、成员函数之前，能被javadoc程序处理 | /** Customer – A customer is any person or organization that we sell services and products to. @author S.W. Ambler */ |
| C语言风格注释 | 注释那些不再使用但是因为某种原因仍然保留的代码 | /* This code was commented out by J.T. Kirk on Dec 9, 1997，because it was replaced by the preceding code. Delete it after two years if it is still not applicable. . . . (the source code ) */ |
| 单行注释 | 在成员函数内部使用，说明事务逻辑或者声明临时变量 | //Apply a 5% discount to all invoices //over $1000 as defined by the Sarek //generosity campaign started in //Feb. of 1995. |
注释主要包括哪些内容：
| 注释项目 | 注释包含的主要内容 |
| 参数 | 参数类型 前提或者限制条件 作何用途 示例 |
| 属性 | 描述 示例 并发性问题 可见性 |
| 类 | 类的用途 已知的bug 开发及维护历史 并发策略 |
| 接口 | 用途 该怎么使用，以及不能怎么使用 |
| 局部变量 | 用途 |
| 成员函数（javadoc） | 此函数的用途 返回值是什么 已知的Bug 可能会抛出的异常 代码修改历史 怎么调用这个函数 使用此函数的前提条件 |
| 成员函数的内部注释 | 控制结构 某段代码的功能 局部变量 复杂的语句 处理的顺序 |
