代码部分的目的是描述软件系统中重要、复杂、意义重大部分的实现细节。比如,我为自己曾参与过的软件项目写了以下内容。
- 生成/渲染HTML:对生成HTML的内部框架的简短描述,包括主要的类和概念。
- 数据绑定:根据HTTP POST请求更新业务对象的方法。
- 多页数据采集:简短描述构建跨网页表单的内部框架。
- Web MVC:正在使用的Web MVC框架的一个使用示例。
- 安全性:使用Windows身份基础(WIF)进行认证和授权的方法。
- 域模型:域模型重要部分的概览。
- 组件框架:简短描述为了在运行时重新配置组件而构建的框架。
- 配置:简短描述代码库中使用的标准组件配置机制。
- 架构分层:分层策略和用来实现的模式的概览。
- 异常和日志:总结在各个架构分层中处理异常和记录日志的方法。
- 模式和原则:解释模式和原则 如何实现。
- 等等。