别给糟糕的代码加注释-重新写把
3、注释
注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败
1、注释不能美化糟糕的代码
带有少量的整洁的而有表达力的代码，要比带有大量注释的零碎而复杂的代码像样的多，与其花时间写注释，不如花时间清洁那堆代码
2、用代码来阐述
创建一个与注释所说的事物的函数
3、好注释
3.1 法律信息
注释不应该是合同或者宝典，只要有可能，指向一份标准许可或者其他外部文档，而不要把所有条款放在注释中
3.2 提供信息的注释
3.3 对意图的解释
4、阐释
注释把某些说不明白的参数或者返回值变为我们可以理解的形式
5、警示
警示其他程序员会出现某种后果的注释也是有用的
6、TODO注释
可以注释要做的工作列表
7、放大
放大某些不合理之物的重要性
8、javadoc
9、避免以下坏注释
9.1 喃喃自语的注释
9.2 多余的注释
9.3 误导性注释
9.4 循规式注释
9.5 日志式注释
9.6 废话注释
9.7 可怕的废话
10、能用函数或者变量的时候就别用注释
11、位置标记
尽量少用标记栏，只在特别有价值的时候用。
12、括号后面的注释
13、归属和署名少放一些 svn和git记录的有
14、最好不要有注释掉的代码
15、不要用HTML标签去注释
16、注释要挨着它注释的代码
17、注释信息不要过多
18、注释及其代码之间应该有显而易见的联系
19、为段函数选个好名字，比写函数头注释好
转载：https://blog.csdn.net/yan88888888888888888/article/details/101371656
查看评论