关于程序注释

读书笔记 Add comments

1. 是否要写注释

写注释能让你更好的思考程序在干什么,但是糟糕的注释适得其反。

2. 如何高效的注释

应该通过书写具有意义的变量名,子程序名来避免过多的注释。注释不是重复描述代码,而是对代码的补充说明。

3. 不要注释糟糕的代码,应该重写之。

4. 文件头部的注释应该起到概述的作用,说明文件的内容和实现的主要功能。

5. 对于具体环境和值得注意的地方应该注释,这将为今后问题的解决带来极大的好处。

Leave a Reply

You must be logged in to post a comment.

Thx N.Design Studio for this Theme
Entries RSS Comments RSS Log in