一、前言
在多人协作的项目中，除了良好的代码规范外，完整的api文档也相当重要。通过文档我们快速了解系统各模块的实际接口，及其使用场景、使用示例，一定程度上降低沟通成本，和减少后期维护中知识遗失等风险。
对于.net，我们可以直接将类、方法等的注释直接转为api文档，极大地减少文档维护的工作量，同时也能反向提高大家的注释质量。
下面我们使用.net唯一的注释生成api文档工具——sandcastle和sandcastle help file builder来实现api文档自动化吧！
二、工具
三、从注释到api文档
1. 生成xml文档文件
步骤：1. 在vs中，右击程序集->选择“属性”->选择“生成”页->勾选“xml文档文件”
2. 编译程序集后，在生成目录下可以找到“程序集名称.xml”文件。
2. 使用sandcastlebuildergui.exe生成api文档
安装工具sandcastle和sandcastle help file builder后，点击sandcastlebuildergui.exe即可进入文档生成项目的界面。
步骤：1. 配置文档基本信息：点击“help file”页
按照上图，依次配置文档标题，文档名称，文档语言，文档风格。
2. 将程序集dll和xml文件加载到文档生成项目中。
右击“documentation sources”，选择“add documentation sources”，然后将程序集dll和xml添加进来即可。
3. 生成api文档
点击菜单栏的“documentation”->“build project”即可，此时只需到sandcastle help file builder.exe所在的目录即可找到api文档了。
四、总结
上述仅介绍了sandcastle help file builder的部分功能，日后将逐渐补充。
五、参考
http://guojun2sq.blog.163.com/blog/static/643308612010116394430/
http://www.boyd.cn/info_show.asp?articleid=4945
http://blog.csdn.net/chtnj/article/details/8278342
http://blog.csdn.net/chtnj/article/details/8278360