学习目的：
1，为什么要注释
2，怎么做注释
为什么要注释
刚开始入行的时候，觉得代码自己看得懂就可以。写注释干嘛？浪费时间。后面又一次我的代码被大佬review，一顿恶骂后，我还是没有觉得这个重要性。直到有一天我背安排对一个功能进行二次开发的时候，我记得我从早上打开电脑能够嘴巴开始碎碎念到下班的时候，才明白：注释真的很重要。
1，方便自己排查问题
2，方便后面的同事填坑
3，为了人身安全
4，为了涨薪
怎么做注释
开头：
/**************************************************************************************************
* Name: CPQ_DiscountVocherCtl
* Object:
* Purpose: Controller for Aura CPQ_DiscountVoucher
* Author: Christ Lai([email protected])
* Create Date: 2019-08-07
* Modify History:
* 2019-08-07 xiong lai Create this class
**************************************************************************************************/
中间：
1，内部类的变量要给字段后面写上中文备注，这个字段啥意思（大部分命名很难做到见名知意）
2，方法上面写上【方法的功能】【方法的入参意义】【修改内容、时间、作者、邮箱】
3，在重要的List，Set，Map定义的变量上写上啥意思（最好在开发入场前，先熟悉开发的代码规范）
4，如果涉及到特别复杂的判断，逻辑等。尽量长的要scroll才能看到的一句代码拆成多个原子代码，这样后面的人会感谢你的。比如if(A||((B&&C）|| D&&G)....)反正我也不知道我自己写的到底缺了括号没。这种语句，最好多定义几个变量每个逻辑放一个变量，加上注释。
后面：
1，这部分看大家的意愿
1）我建议在apex的类后面写上自己类涉及的测试数据，每个刚写完的人最熟悉数据构造。可能隔一天在回头写，作者自己还要琢磨琢磨怎么创建数据。这个能节省很大的人力成本，亲测！！！
2）结尾的地方如果有未完成的事情，新加一个TODO FIXED表格
/**************************************************************************************************
Requirement Date Author Status
xxxxx xxx xxxx TODO
xxxxx xxx xxxx FIXED
**************************************************************************************************/
如果有错，请指出。一起进步！