The Elements of C# Style - Documentation
摘要：
1. 一般原则 1.1 为使用接口的人编写软件接口文档 编写文档注释的首要目的是在服务的提供者(supplier)和客户(client)之间定义一种编码契约(programming contract)。与方法相关的文档应该描述该方法的调用者可依赖的行为的诸多方面，而不应该试图描述其实现细节。 1.2 为维护者编写代码实现文档 编写代码实现部分文档，好让别人可以维护和增强代码。总是假定会有完全不熟悉你的代码的人要阅读和理解你的代码。 1.3 为维护者编写代码实现文档 编写代码实现部分的文档，好让别人可以维护和增强代码。总是假定会有完全不熟悉你的代码的人要阅读和理解你的代码 1.4 保持... 阅读全文
posted @ 2012-08-25 10:52 lufangtao 阅读(273) 评论(0) 推荐(0) 编辑
