一、过去的做法
之前写代码时,我习惯想到哪写到哪,几乎不写注释。要是遇到功能调整,自己回头看代码都得花好久梳理逻辑,更别提和同事协作时,别人理解我的代码有多困难了。
二、结合书中分析不足
书中强调代码的可读性和可维护性对软件项目很关键,注释是提升可读性的重要手段 。我过去不写注释的做法,让代码成了 “个人专属密码”,一旦项目迭代或人员变动,理解和维护成本大幅上升,不符合团队协作开发中代码应具备清晰表意的要求。
三、解决办法
制定注释规范,比如函数开头注释要说明功能、入参含义、返回值情况,复杂逻辑代码段添加行注释解释意图,每次提交代码前,自查注释是否完整、清晰,逐步养成良好编码习惯。
浙公网安备 33010602011771号