下载地址: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的原因之一。