使用Sandcastle创建你的类库文档- 让生活Web个够- 博客园

1. 必备工具:

 1. 1

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   和

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

  2.1 使用  

  2.2 使用方式

 

  2.3 使用

 

3.  示例

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

  3.2 打开下载到的工程文件 ,  打开XMLsample.cs, 可以看到各种注释的详细解释(想了解更多注释, 请查看).

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

会出现, 一路选择设置, 点击Next,   , {zh1}可得到项目.

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

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

  3.6 完成 .

 

4. 一些相关链接:

  4.1 

  4.2 

  4.3 

  4.4 


郑重声明:资讯 【使用Sandcastle创建你的类库文档- 让生活Web个够- 博客园】由 发布,版权归原作者及其所在单位,其原创性以及文中陈述文字和内容未经(企业库qiyeku.com)证实,请读者仅作参考,并请自行核实相关内容。若本文有侵犯到您的版权, 请你提供相关证明及申请并与我们联系(qiyeku # qq.com)或【在线投诉】,我们审核后将会尽快处理。
—— 相关资讯 ——