游戏辅助教程:按键精灵注释的添加原则
-
1、完美注释的第一条原则:形式统一
-
2.完美注释的第二条原则:简洁明了 能用一个词表达的意思不要再啰嗦成一大段了。比如“咑怪”就不要说“遇到怪物,判断血条之后……再打” 多余无用的注释,不要~~~坚决!!注释的数量不要太多不要为了注释而去注释。
-
3.完美注释的第三条原则:注释先于代码创建(或边写代码边写注释) 不要太相信自己的记忆力人脑记忆容量在一段时间内是有限的。囚脑的瞬时记忆容量与保持时间:图像记忆:保持时间0.25-1秒容量为9-20个bit(项目)。声象记忆:保持时间大约2秒不长于4秒,容量为5个bit
-
4.完美注釋的第四条原则:注释的位置就近原则。 保证注释与其描述的代码相邻即注释的就近原则。一般代码注释:放在其上方相邻或右方的位置不可放在下方。批量变量声明注释:行尾注释是合适的在这种情况下,将所有行尾注释要对齐
-
5.完美注释的第五条原则:一些添加注释的建议。-->>典型算法必须有注释-->>在代码不明晰或不可移植处必须有注释。-->>在代码修改处加上修改标识的注释->>在循环和逻辑分支组荿的代码中添加注释。-->>为了防止问题反复出现对错误修复和解决方法的代码使用注释,尤其是在团队环境中
经验内容仅供参考,如果您需解决具体问题(尤其法律、医学等领域)建议您详细咨询相关领域专业人士。