用按键精灵编写代码时,注释写还是不写?
观点清晰简洁的注释还是很有必要的。良好的代码习惯,能带来事半功倍的效果。
不管是作为范例给别人参考,还是多年后自己翻出当年的代码,良好的注释都能一目了然。
操作方法
- 01
单引号:'需要注释的内容 1. Call 自动打怪() '调用自动打怪子程序
- 02
/*需要注释的内容*/ 1. Call 自动打怪() /*调用自动打怪子程序*/
- 03
//需要注释的内容 1. Call 自动打怪() //调用自动打怪子程序
- 04
完美注释的第一条原则:形式统一 简洁明了的注释,全文都用一种固定格式的注释形式,不要一会用//,一会用'
- 05
完美注释的第二条原则:简洁明了 能用一个词表达的意思,不要再啰嗦成一大段了T_T。比如“打怪”,就不要说“遇到怪物,判断血条之后……再打” 多余无用的注释,不要~~~坚决say no 注释的数量不要太多,不要为了注释而去注释。
- 06
.完美注释的第三条原则:注释先于代码创建(或边写代码边写注释) 不要太相信自己的记忆力,人脑记忆容量在一段时间内是有限的。你一转身就可能忘记你刚刚脑子里想的事呢。 人脑的瞬时记忆容量与保持时间:图像记忆:保持时间0.25-1秒,容量为9-20个bit(项目)声象记忆:保持时间大约2秒,不长于4秒,容量为5个bit
- 07
完美注释的第四条原则:注释的位置,就近原则。 保证注释与其描述的代码相邻,即注释的就近原则。一般代码注释:放在其上方相邻或右方的位置,不可放在下方。批量变量声明注释:行尾注释是合适的,在这种情况下,将所有行尾注释要对齐。
- 08
完美注释的第五条原则:一些添加注释的建议。-->>典型算法必须有注释。-->>在代码不明晰或不可移植处必须有注释。-->>在代码修改处加上修改标识的注释。-->>在循环和逻辑分支组成的代码中添加注释。-->>为了防止问题反复出现,对错误修复和解决方法的代码使用注释,尤其是在团队环境中。