关于代码注释和文档的重要性

今天有个以前的工具出了点问题, 因为不是自己在用, 所以没什么印象只有去翻下代码.
虽然有些注释在里面, 但是出错的地方一点注释都没有, 而且也忘记了整个工具是干什么的.
看了下git的最后提交时间是2017.3.12, 才过去一个多月就忘记了.
虽然后面通过看代码回忆起来了, 但这事给我一个提醒: 不要相信自己的记忆力.

一直以来写代码都没写过文档和记录, 注释也是才慢慢的写上的, 看来以后写代码得给自己定个标准了.

需求文档必须有, 记录下这个项目是干什么的, 最好详细记录下每个操作是怎样的.
注释更全面些, 尤其是各种变量, 要注释上这个变量是用来干什么的, 而不是注释这个变量是什么.

标签: none