使用Sandcastle创建你的类库文档

1. 必备工具:

 1. 1 Sandcastle

Documentation compilers for managed class libraries
Enabling managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel.

 1.2 HTML Help Workshop  和 Microsoft .NET Framework Version 2.0

2. 使用Sandcastle 生成文档的几种方式:

  2.1 使用 SandcastleGUI 

image

  2.2 使用命令行方式

 

  2.3 使用DocProject

image  image

3.  示例

  3.1 先编写一个类库, 这里我使用MSDN上包含有标准注释的"XML文档"示例, 可到这里下载.

  3.2 打开下载到的工程文件image ,  打开XMLsample.cs, 可以看到各种注释的详细解释(想了解更多注释, 请查看建议的文档注释标记(C# 编程指南)).

  3.3 这里使用DocProject方式, 在确保安装了DocProject后, 为工程添加新项目image,

会出现image, 一路选择设置, 点击Next,  image image , 最后可得到项目image.

  3.4 编译DocProject前, 务必使你所要生成文档的类库编译输出注释的XML文件,  详细方法请查看在 Visual Studio 中生成“XML 文档”.

  3.5 编译DocProject项目, 等待十几分钟(似乎有点慢, 即使类库很小), 就会在该项目下看到HTML版和CHM版的文档了.

  3.6 完成image .

 

4. 一些相关链接:

  4.1 Sandcastle -- Documentation Compilers for Managed Class Library

  4.2 Creating a Chm build using Sandcastle

  4.3 创建专业级别的类库使用文档——Sandcastle十一月份CTP发布

  4.4 Sandcastle初探——官方版的NDoc

posted @ 2007-06-26 14:34  MK2  阅读(1456)  评论(1编辑  收藏  举报