《凌波微步:软件开发警戒案例集》读后感
阅读《凌波微步:软件开发警戒案例集》案例一 有感
在这本书中,作者提到的第一个案例是与注释规范有关的。
看似“详尽”的注释实则是个失败的注释。注释不需要逐条语句进行“教科书”一样的解释,而是需要在适当的地方简洁明了的告诉大家,这一语句或者这一个程序块是要干什么的,按照作者的话来说,关于程序语言的基础知识点不要做出注释,需要注释的是整块代码的意图及运用到的相关外部知识。
上述“详尽”现象,作者称其为“亦步亦趋”。好的注释,会让程序员在看过一遍注释之后可以快速掌握这个程序的功能以及编码思路,从而节约时间,提高效率。注释并不是越多越好。
除此之外,作者提出的,好的编程规范也是一个很重要的“注释”,适当的空行,清晰有层次的代码缩进也会让人一目了然。
综上,适当合理的注释加上良好的编程规范会给“后来人”带来极大的便利,这也是一个好的程序代码所需要的。
以上就是我对第一个案例的感受。
浙公网安备 33010602011771号