用微软Sandcastle创建.NET文档

输出结果

Sandcastle生成的输出结果具有以下特点：

• 类似于MSDN布局的界面。
• 自动生成索引项、内容项目表、主题块和页面布局，提高一致性和熟悉程度。
• 自动生成语法宣称部分。
• 自动生成继承表。
• 代码彩色化。
• 提供多种风格和语言选择，终端用户可从中选择自己最喜欢的形式。

输出结果以HTML和CSS形式显示，微软承诺将来提供更多选择。

可选界面

许多开发者讨厌命令行界面——他们更喜欢灵巧的GUI界面，如流行的Visual Studio IDE。同时，你还可以使用第三方工具，利用一个友好的GUI界面推动Sandcastle过程。以下是三个有效的工具：

• Sandcastle Help File Builder：它提供一个类似于NDoc的界面，允许你输入现有的NDoc项目，自动完成创建过程。
• SandcastleGUI：这是一个免费的Sandcastle GUI前端界面。
• Sandcastle CHM编译BAT脚本和配置实用工具：这是一个配置实用工具和批处理脚本，由它通过Sandcastle可建立MSDN形式的类文档CHM文件。

帮助他人

如果开发者处理应用程序代码，他们需要了解应用程序的工作原理，以及如何使用应用程序界面。微软Sandcastle提供为你的项目生成MSDN形式文档所需的必要工具。检查这个Sandcastle wiki了解该工具。

你一直都对代码归档吗？在开发文档时你使用哪些工具和技巧？请在文后的讨论部分与社区分享你的观点和经历。

Tony Patton拥有丰富的Java、VB、Lotus及XML方面的知识，是一个专业的应用程序开发人员。

责任编辑:张琎

查看本文国际来源