Sandcastle----强大的C#文档生成工具

 Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为我们提供完美的.NET类库文档成为一个可能。

      来一步一步的看下整个生成过程:

     1.从这里下载最新的Sandcastle后安装.     

   2.从这里下载今年才发布的Sandcastle Help File Builder.

     3.安装完成后直接新建项目,主窗口会直接打开项目属性,这里就是对生成文档的主要配置区域。

我们先添加需要生成文档的源。右击项目中的Documentation Sources可以添加多种文件类型(sln,proj,xml,dll,exe) 

     4.对主要的属性进行设置.

       FrameworkVersion: 选择对应的Framework版本

       HelpFileFormat :  选择需要生成的文档的格式. 注意这里选定的格式要在下面对应的地方进行设置.

                              注意对于不同的格式还需要安装不同的编译工具 Helpe1x(chm)需要安装Microsoft HTML Help,Helper2x(Hxs)需要安装 Hxcomp.

      NamespaceSummaries:  选择需要生成的命名空间,直接点击开窗选择。这可强大多了,之前用命令行或者其它工具都是要手动输入。

      Lanugages :语言一定要选择中文,这会使一些文档里的一些文字自动生成中文

      CopyrightHref:版权链接

      CopyrightText: 版权文字

      HelpTitle: 文档标题

      HtmlHelpName:文档生成文件名称

      PresentationStyle: 这里现在支持vs 2005,Prototype等格式 ,根据自己需要选择

      OutputPath:生成路径

      Show Missing Tags:下面的一些设置根据需要在最终版生成时设置成True,不然会在文档中出现红色的提示.

    设置完成的界面如下:

      

      5.点击上面的生成菜单或者按钮,就可以直接打开生成过程界面,在这里可以直接查看生成过程中的一些提示和错误.生成完成后,一个和MSDN风格一致的文档就出来了:

        

     6. 而且支持在文档中插入图片,插入代码等功能。

     7.代码规范是最根本的前提,一定要在代码中提加足够的注释。

资源:

          Sandcastle Help File Builder: http://shfb.codeplex.com/

          SandcastleGUI:http://www.inchl.nl/SandcastleGUI/

    之前一直使用的另外一个Sandcastle生成工具

          用Sandcastle和Help Integration Wizard把文档集成到Visual Studio

          http://www.cnblogs.com/fox23/archive/2008/09/09/using-sandcastle-integrated-help-documents-into-visual-studio.html

转:http://www.cnblogs.com/lonely7345/archive/2010/01/13/1647245.html

时间: 2024-09-29 12:50:36

Sandcastle----强大的C#文档生成工具的相关文章

pdf-javaweb强大的在线文档编辑工具、转换为PDF插件用什么比较好?

问题描述 javaweb强大的在线文档编辑工具.转换为PDF插件用什么比较好? 工作中需要进行文档的编辑,现在用的是ueeditor编辑并生成html传到后台,再通过wkhtmltopdf转换为pdf: 但是领导说ueeditor编辑器的文档编辑功能还不够想要更强大的编辑器: 领导还说wkhtmltopdf在转换过程中会出现乱码(Linux服务器,可能是因为字体文件不存在等原因),所以想换个别的转换工具,请问大神们对这两种类型的软件有没有什么比较好用的推荐一下,谢谢了 解决方案 用itext,一

.NET平台开源项目速览(4).NET文档生成工具ADB及使用

原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用     很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧.例如本文在: .NET平台开源项目速览(2)Compare .NET Objects对象比较组件 .NET平台开源项目速览(3)小巧轻量级NoSQL文件数据库LiteDB 上述2篇文章中最后的资源中就手动制作了CHM帮助

[置顶].NET平台开源项目速览(4).NET文档生成工具ADB及使用

    很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习一些开源项目的过程中,官方没有提供CHM帮助文档,所以为了快速的了解项目结构和注释.就生成文档来自己看,非常好用.这也是一个学习方法吧.例如本文在: .NET平台开源项目速览(2)Compare .NET Objects对象比较组件 .NET平台开源项目速览(3)小巧轻量级NoSQL文件数据库LiteDB 上述2篇文章中最后的资源中就手动制作了CHM帮助文档.有时候我们还可以对源码进行翻译,再制作,效果还不错.今天介绍的A

Doxygen自动文档生成工具在Eclipse中的集成及使用举例

你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码 然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的办法呢?比如根据代码注释自动生成详尽的说明文档--可能有人会说用Javadoc就是 了,要是C/C++.Python.C#等语言写的软件呢?有没有类似Javadoc的东西? Yes,当然有,Doxygen就是这样一个能满足你需求的工具.Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的

Python文档生成工具pydoc使用介绍

  这篇文章主要介绍了Python文档生成工具pydoc使用介绍,本文讲解了基本用法.获取帮助的方法.生成的文档效果图等内容,需要的朋友可以参考下 在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc.doxygen.sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc. pydoc是Python自带的模块,主要用于从python模块中自动生成文档,这些文档可以基于文本呈现的.也可以生成WEB 页面的,还可

给 Web 开发人员推荐的文档生成工具

工欲善其事必先利其器,在此给 Web 开发人员推荐几款优秀的开源文档生成工具,希望能对大家有所帮助. 1.JavaScript JSDoc 3 这是一款根据 Javascript 文件中注释信息,生成 JavaScript 应用.库.模块的 API 文档的工具.你可以使用它记录如:命名空间.类.方法.方法参数等.该项目还衍生出了许多模板和其他工具来帮助生成和自定义文档,比如: 模板 jaguarjs-jsdoc DocStrap (example) jsdoc3Template (example

DBImport v3.44 中文版发布:数据库数据互导及文档生成工具(IT人员必备)

前言: 距离上一个版本V3.3版本的文章发布,已经是1年10个月前的事了. 其实版本一直在更新,但也没什么大的功能更新,总体比较稳定,所以也不怎么写文介绍了. 至于工作上的事,之前有半年时间跑去学英语.考驾照.到健身房请私教,远离了一下代码的世界,现在又回归了. 最近上班了,新的公司需要招.NET系.产品经理,有兴趣的可以左侧扣我(我部门要人,地点广州). 另外:阿里最近收购了一家公司,也需要Java系的高手和测试人员,有兴起的也可以扣我(我朋友的部门要人,地点广州). 嗯,闲话少说,看看工具的

.Net工具 - .NET文档生成工具2.2

ADB2.2下载   ADB2.2源代码下载 一.概述 程序的注释在程序的编写和维护中扮演着相当重要的角色,在生成工程的同时,说明文档也随之而生了..NET文档生成工具用于将xml 文档注释生成格式类似MSDN的HTML帮助文档,并编译为CHM文档(下文中将该工具称为ADB,该软件仅测试过.net2.0的程序集). 二.ADB2.2的功能特点 1.支持合并多个程序集: 2.自动搜索程序集及其引用的程序集对应的XML文档(包括.Net自带的程序集,如:system.xml): 3.灵活控制在文档中

【C#附源码】数据库文档生成工具支持(Excel+Html)

     [2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的编写了数据库文档生成工具,供大家交流学习之用,与程序员共勉.     该工具为C#控制台,以NPOI为基础,操作Excel.简单方便,简单配置.两次回车,OK!即可生成清晰的数据库文档.另外,支持生成HTML文档.源码大小7MB,OS上传不了,放到百度云盘里了:http://pan.bai