前几天做黑马基础测试试题，题目要求写注释，
之前看视频教程老师也说到要养成写注释的好习惯，
上次做题目时，尽管写了详细的注释，但是有些小问题：
第一：注释写上了，害怕不够，不便于日后自己阅读和他人阅读；
第二：写多了，看着好烦，不便于他人阅读，自己写着也非常麻烦；
第三：不知道怎么写精简有效的注释。
所以在这里求写注释心得？{:soso_e132:}

类的成员及方法要写文档注释，类也可以写文档注释，说明这个类的作用，如实体类、sql类。。。
在一些重要的或者不熟悉的代码后面写好注释，方便以后的阅读与修改

个人觉得，注释如果函数或者类写一个文档注释，说明累或者函数功能，返回值。代码中自己觉得比较复杂的，不能一眼就看明白这段代码什么意思的地方可以写一下注释。这个应该没有什么硬性的规定，写注释，就是为了别人或者很长时间过后自己能够很轻松的看懂你写的代码是什么东西，能干什么就可以了！

我写注释时候习惯：1、类或者函数上部简明说明用途，可以强调内部实现机理，比如函数中间要使用贝叶斯方程，那么就注此函数使用贝叶斯公式实现某某功能等；2、函数内部复杂变量说明用途比如前面对应贝叶斯公式而定义的名称变量；3、复杂表达式进行原理注释，比如前面的贝叶斯公式实际运算表达式后面注明变量代表什么，运算国际公式等。个人之间建，勿笑。

1、按照国际规范来书写；2、按照“想想一个对编程一窍不通的普通人来看你的代码”的要求来写