写朴素的注释,而不是豪华的。简单的告诉你和你的协作者,这个文件是做什么的,这个函数是做什么的,是最最重要的注释,哪怕别人说看起来像给傻子看的。写代码,应保持真诚,诚实,谦虚,而不是故弄玄虚。在代码规范上,可以有一条硬性要求,即每个文件/模块或类,每个函数或方法均必须无条件写一行注释,告诉我们它是做什么用的。
2