团队里有个大佬,他写的注释特别详细。他的注释通常包含很多内容。刚开始的时候,我不太在意他写这么详细的注释。可后来遇到问题时,像是用到某个接口需要关注相关技术细节,或者接口返回值和预期不符的时候,总能在他的注释中找到解释或者引导,这时我才明白这么做的意义,心里也常常暗自感叹:大佬真厉害。我感觉对他来说,写代码就像阳明心学里讲的,是一种用敬的功夫,从他写注释的认真态度就能看出来。也许有人会觉得这些内容最好写在设计文档里,而不是注释里。但在实际项目中就会发现,有时候根本没时间为一些小改动做设计文档。并且写在注释里还有比文档更便利之处,例如查看方便。会写注释的人写出的注释很有价值;不会写注释的人,写了注释也和没写差不多,甚至还可能起到反作用,比如注释和实现不匹配从而误导后来的人。
Copyright © 2025 IZhiDa.com All Rights Reserved.
知答 版权所有 粤ICP备2023042255号