记录

1.关于方法

两方面：

1）在自己编写方法时要注意，需要注明方法解决了什么问题，该如何使用（入参都有哪些，各个的含义都是什么，出参又是什么）（或者pre-conditions是什么，post-conditions是什么）。 2）当然这是站在自己的角度看待自己编写的方法，在自己使用别人编写的方法时，弄清楚方法解决了什么样的问题，入参都是些什么，各自代表什么样的含义，出参又是什么，方法所属的对象和类是谁，也同样的非常重要——因为这直接决定了自己能否合理的使用这个方法。

2.关于注释

注释要尽量详尽，同样的也可以从两方面来看待

· 1）站在读者的角度，应该要考虑到，读者能否通过注释很直观的了解到程序（或）程序片段

是什么，要做什么事情，以及一些复杂隐晦的细节能否迅速的被读者接受，甚至在读者需要改动程序中的部分地方以实现个性化的功能时，读者也能够迅速定位并作出与程序前后文一致的修改。

2）站在自己的角度而言，最为重要的则是，自己编写的注释，一定程度上能够完整的、有逻辑的体现我的程序做了些什么事情、重要的点在哪里、复杂的点在哪里，甚至于能体现出我的程序风格是什么样的——这就像写一篇散文一样，能够做到形散神不散，