1. 每个文件头部保留一定的注释来解释这个文件所做的事情；
2. 每个方法、函数的头部要有一定注释来解释这个方法、函数所要做的事情；
3. 如果代码中的逻辑无法一下子看出具体的逻辑，需要加上注释对这段逻辑进行说明；
4. 在关键点留下说明，以方便后续维护；
5. 如果一份文件由多人维护，则需要添加如下注释区分不同的人进行的修改，例：
// ---------- ↓↓↓ waygc 2019/12/18 新增 开始 ↓↓↓ ----------
// ---------- ↑↑↑ waygc 2019/12/18 新增 结束 ↑↑↑ ----------
/* ---------- ↓↓↓ waygc 2019/12/18 新增 开始 ↓↓↓ ---------- */
/* ---------- ↑↑↑ waygc 2019/12/18 新增 结束 ↑↑↑ ---------- */
＜!-- ---------- ↓↓↓ waygc 2019/12/18 新增 开始 ↓↓↓ ---------- --＞
＜!-- ---------- ↑↑↑ waygc 2019/12/18 新增 结束 ↑↑↑ ---------- --＞
-- ---------- ↓↓↓ waygc 2019/12/18 新增 开始 ↓↓↓ ----------
-- ---------- ↑↑↑ waygc 2019/12/18 新增 结束 ↑↑↑ ----------
6. 代码中有暂时不处理的内容，要把代码注释掉，并加 TODO 来标识；
7. 因为业务上需要修改某项内容，注释格式如下：
// [日期(格式=20240101)] 根据某某要求，修改了某某条件