使用 Document!X 为自己的dll生成一个漂亮的说明文档

下载地址：http://www.innovasys.com/products/dx/overview.aspx

此软件与sandcastle的作用差不多，都是用来通过dll的xml注释生成说明文档。

在生成之前，首先需要写好xml注释，关于xml注释的使用请参考http://hi.baidu.com/czlaner/item/2fa0d48398a32aebe496e092

并且在项目生成时选择生成xml文档

使用document!X新建一个项目

为dll生成使用assembly项目即可，其他还有一些别的项目

此项目是一个示例项目，里面有一些示例性的文档，可以把他们都删掉

添加我们希望生成的 dll，可以在assemblies目录上右键--添加，也可以用顶部的工具按钮，或使用project quick start页中的按钮

添加了assembly，会自动在content files为这个assembly添加一个dxc文件。

可以打开这个dxc文件，对立面自动生成的内容做更进一步的说明

如果需要一个综合性的文档页面，可以添加一个topic

name尽量使用英文，中文生成时会有乱码，而title则可以使用中文。

希望在生成出来的文档左侧的导航中显示此页面的连接，需要在table of contents中加入此文档

可以对位置进行排序

最后点击工具栏中的

可以生成2种，html页面和chm（chm其实就是html页面的打包），以及为vs2010和2012使用的帮助文档。

如果你看到这样的提示

不要担心，看看log吧

HHC6003: Error: The file Itircl.dll has not been registered correctly.

他说有个dll没有正确注册，但其实我这里是正确注册的。

并且到项目所在文件夹查看，他已经生成了chm

目录中的中文编程了乱码，并且文档的结构是英文的

打开此文件

将所有的语言都是设置成中文。

打开online and chm。

给chm文档起个名字（最好是英文）

设置起始页

重新生成（如果你正打开chm文档，请先关闭）。

从xml注释生成chm文档有很多工具，对中文不错的支持是我选用document!X的原因之一。

转载于:https://www.cnblogs.com/czcz1024/archive/2012/12/05/2803007.html

使用 Document!X 为自己的dll生成一个漂亮的说明文档相关推荐

Doxygen —— 快来为你的代码自动生成一份专属说明文档
简介 Doxygen是一个能从带注释的源码中自动生成说明文档的标准工具,它支持众多流行的编程语言,包括C/C++.C#, PHP, Java, Python, IDL 等 Doxygen能够从以下三个 ...
编程以外积累：如何给项目生成类似VS2008的说明文档
1:[下载] 目前微软提供的官方开源工具 Sandcastle 结果跑到项目中一看,抬头就来了这么一段: The Sandcastle CodePlex project is no longer u ...
Word邮件合并功能详解：合并后生成多个word文档，删除空白页
Word邮件合并功能详解:合并后生成多个word文档,删除空白页最近在实习,干了很多打杂得工作,所以office软件用的很多很多,瞬间觉得自己可以去裸考计算机二级了哈哈哈哈哈哈.今天因为工作用到了邮 ...
自定义maven插件：自动生成API的word文档
继上次开发完Maven插件开发:根据库表生成实体类&根据实体类生成库表之后,博主对开发maven插件喜爱得一塌糊涂.这不,今天给大家带来了<自定义maven插件:自动生成API的word ...
基于GUI的mcc编译和dll生成
基于GUI的mcc编译和dll生成 1.mcc的编译 1.1 MCRInstaller编译器的安装找到Matlab下的MCRInstaller,双击MCRInstaller编译器,运行安装. 1.2 ...
C# 中使用 ThoughtWorks.QRCode.dll 生成指定尺寸和边框宽度的二维码
本文介绍在 C# 中使用 ThoughtWorks.QRCode.dll 生成指定尺寸和边框宽度的二维码.网上文章大多只是简单介绍内置参数的设置,根据我的使用目的,增加了自定义目标二维码图片尺寸和白边 ...
如何用C/C++生成一个为lua所用的动态库dll文件以及lua如何调用该dll(C语言的动态库)
如果读者朋友想详细的了解lua与C的通信原理,请移步这里[https://www.zhangshengrong.com/p/ERNnAzWa5W/]: 先说两句废话:怪不得lua不火,因为它对我们新手 ...
VB传统DLL生成插件安装版 VB DLL LINK .exe
VB传统DLL生成插件安装版 VB DLL LINK .exe 用VB生成标准dll,让任何程序引用. ################################################ ...
DLL生成与调用总结
最近因项目需要将一部分代码封装成DLL供其他程序调用,在这个过程中遇到一些困难,现将过程总结出来,供以后参考. 一.生成DLL 生成DLL比较简单,既可以直接新建一个DLL项目: 也可先新建一个空项目 ...
Kali渗透测试：远程控制被控端免杀及DLL生成、注入反弹
Kali渗透测试:远程控制被控端免杀及DLL生成.注入反弹长期以来,杀毒软件厂商和黑客一直处于博弈的状态,杀毒软件厂商研究了各种检测和清除远程控制被控端的方法,而黑客也在一直致力于研究避开检测的 ...

使用 Document!X 为自己的dll生成一个漂亮的说明文档

使用 Document!X 为自己的dll生成一个漂亮的说明文档相关推荐

最新文章

热门文章