VS2008文档自动生成

(发现,Sandcastle主要是用于C#项目。里面的注释都是XML格式的。不太适合VC的。最终还是得用Doxygen)

一、Sandcastle简介:

Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,其前身为发布VS2005之前,MS内部开发了一个用于生成帮助文档的工具。

二、SandcastleNDoc的简单比较:

NDoc是.Net2003下的文档生成工具,它是一个开源的东东。目前已经停止开发,最新版本不支持2.0。

它们都是通过反射和Xslt技术,从dll文件及其注释(编译时加/doc参数得到)中得到一个完整的帮助文档,文档格式可以是html或chm甚至是任何自定义的格式。

当前Sandcastle最新版本是June CTP,使用的方式仍然是命令行,不提供GUI支持;而且官方网站上给出的使用说明:其只能支持单一的dll,对于Solution仍然没有任何说明。

三、如何利用Sandcastle自动生成.NET2.0开发帮助文档

A.软件安装准备工作:(下载网站:http://shfb.codeplex.com/

1、 必备软件:HtmlHelpWorkshop.exe 网上到处都有;如果本机已经安装就无需理会;

2、下载该软件,网址:http://shfb.codeplex.com/

解压找到文件夹InstallResources;可找到两个安装包Sandcastle_2710.msi;SandcastleHelpFileBuilder_1950.msi

3、开始安装,需要装两个软件(最好默认安装到C:\下)

先安装Sandcastle_2710.msi;

后安装SandcastleHelpFileBuilder_1950.msi

4、安装完毕后,在程序中可以找到“Sandcastle Help File Builder GUI”执行文件,运行:(里面已经新建了一个工程-7)

使用步骤:

1、点击“File”--> New Project -->弹出对话框,输入工程名称,比如:AA,点击保存

2、见AA工程如下图

3、点击“右边AA”下面“Documentation Source”,点击右键Add,选择我们开发项目已经编译好的dll和xml文件(注意:项目编译                  必须输出 xml文件,方法见下面解说)

4、配置相关属性;

①、FrameworkVersion --- 选择对应项目的.net版本(目前支持到4.0)

②、ProjectSummary     ---  项目说明-编译后的chm--Title属性名称

③、HtmlHelpName       ---   输出chm文件的名称

④、HelpTitle                  ---   文件标题说明

⑤、HelpFileFormat      ---   选择HtmlHelp1

⑥、Language               ---   默认选中“英语(美国)”

⑦、CopyrightText        ---   你的版权说明

⑧、DocumentInheritedFrameworkMembers   ---- false    true<将屏蔽继承过来的自带的一些方法说明>

⑨、DocumentInheritedMembers                       ---- false    true<将屏蔽继承过来的自带的一些方法说明>

⑩、OutputPath            ---  输出chm的文件夹

其他属性可默认....

5、点击“Bulid the help file”按钮进行编译操作,

解说:项目生成输出xml文件操作---》点击项目属性,弹出对话---生成--勾选中 输出XML文档文件,下次编译即可输出xml文件

转载自http://blog.163.com/qimo601@126/blog/static/15822093201211129328968/

VS文档自动生成的更多相关文章

  1. Word 2010文档自动生成目录和某页插入页码

    一.Word 2010文档自动生成目录 关于Word文档自动生成目录一直是我身边同学们最为难的地方,尤其是毕业论文,经常因为目录问题,被要求修改,而且每次修改完正文后,目录的内容和页码可能都会发生变化 ...

  2. springboot成神之——swagger文档自动生成工具

    本文讲解如何在spring-boot中使用swagger文档自动生成工具 目录结构 说明 依赖 SwaggerConfig 开启api界面 JSR 303注释信息 Swagger核心注释 User T ...

  3. django接口文档自动生成

    django-rest_framework接口文档自动生成 只针对用到序列化和返序列化 一般还是用第三方yipi 一.安装依赖 pip3 install coreapi 二.设置 setting.py ...

  4. 优于 swagger 的 java markdown 文档自动生成框架-01-入门使用

    设计初衷 节约时间 Java 文档一直是一个大问题. 很多项目不写文档,即使写文档,对于开发人员来说也是非常痛苦的. 不写文档的缺点自不用多少,手动写文档的缺点也显而易见: 非常浪费时间,而且会出错. ...

  5. java 文档自动生成的神器 idoc

    写文档 作为一名开发者,每个人都要写代码. 工作中,几乎每一位开发者都要写文档. 因为工作是人和人的协作,产品要写需求文档,开发要写详细设计文档,接口文档. 可是,作为一个懒人,平时最讨厌的一件事情就 ...

  6. API的文档自动生成——基于CDIF的SOA基本能力

    当前,作为大部分移动app和云服务后台之间的标准连接方式,REST API已经得到了绝大部分开发者的认可和广泛的应用.近年来,在新兴API经济模式逐渐兴起,许多厂商纷纷将自己的后台业务能力作为REST ...

  7. PDF 补丁丁 0.6.1.3498 版重大更新:为文本PDF文档自动生成书签!

    新的 PDF 补丁丁开放了内部测试了很久的好用功能——自动书签. 这个功能可以在一分钟内快速生成文本型 PDF 文档的书签(说明:本功能分析文档中的文本,生成标题,故对扫描版的 PDF 文档无效). ...

  8. sphinx:python项目文档自动生成

    Sphinx: 发音: DJ音标发音: [sfiŋks] KK音标发音: [sfɪŋks] 单词本身释义: an ancient imaginary creature with a lion's bo ...

  9. 如何让接口文档自动生成,SpringBoot中Swagger的使用

    目录 一.在SpringBoot项目中配置Swagger2 1.pom.xml中对Swagger2的依赖 2.编写配置类启用Swagger 3.配置实体类的文档 4.配置接口的文档 5.访问文档 二. ...

随机推荐

  1. 上海-北京间通过Azure Storage的RA-GRS类型的存储账户进行快速复制

    Azure的Blob存储分成多种类型,目前主要有: 其中RA-GRS可以在上海-北京两个数据中心间同步数据.并且,在第二个数据中心可以只读的方式读取这个存储账户中的Blob内容. 虽然GRS采用的是准 ...

  2. paramiko使用1

  3. PCB设计基础及技巧

    一.设计步骤 (1)PCB布局 先放置接口类外设: 根据飞线的接口方向,定位各个模块的方位: 局部模块化(按照一个方向逐个局部化): (2)PCB布线 设置设计规则: 先布过孔(电源.地.长线),防止 ...

  4. MS SQL update set select

    有张表a,已经有数据 再有张表b,也已查询出数据 两张表有外键关联 需求如下: 更新表a中的某个字段,这个字段要加上(都是int型的数据)对应表b中的数据作为更新的最终数据 )) from #libL ...

  5. hadoop mapreduce 计算平均气温的代码,绝对原创

    1901 46 1902 21 1903 48 1904 33 1905 43 1906 47 1907 31 1908 28 1909 26 1910 35 1911 30 1912 16 1913 ...

  6. redis 有用 Sorted-Set 应用场景

    1.1.1Set数据类型的 使用场景 1.可以使用Redis的Set数据类型跟踪一些唯一性数据,比如访问某一博客的唯一IP地址信息.对于此场景,我们仅需在每次访问该博客时将访问者的IP存入Redis中 ...

  7. 15、TSA数据上传(https://www.ncbi.nlm.nih.gov/genbank/tsaguide/#SP)

    https://www.ncbi.nlm.nih.gov/genbank/tsa/ https://www.ncbi.nlm.nih.gov/genbank/tsaguide              ...

  8. CodeForces 492A Vanya and Cubes

    A. Vanya and Cubes time limit per test 1 second memory limit per test 256 megabytes input standard i ...

  9. 2、Spark基本工作原理与RDD

    一.基本工作原理 1.特点 分布式: 主要是基于内存(少数情况基于磁盘): spark与,MapReduce最大的不同在于迭代式计算: MR分为两个阶段,map和reduce,两个阶段完了我们,job ...

  10. 6.1 安装Ubuntu

    声明:sunny从来没有接触过linux.今天是第一次接触linux,日后每天都会接触linux了.坚持,每日练习,相信毕业后的我,一定会从小白成为linux大神. 安装Ubuntu之前,请先参考该博 ...