Atomineer工具是用来生成源代码注释的vs插件,功能非常强大,还能导出chm或html格式方便查看,但是需要破解, 破解方法为: =================================== 第一次请务必断网进入VS,在插件里面把本工具的自动更新关闭掉,更新到最新版本将直接无法使用。
VS 2015之下的版本(未测试是否可用): 安装路径自己选的,然后找到:你的安装路径/visual studio ****/Addins/AtomineerUtils/ 替换掉里面的Atomineer.Utils.dll就好了
VS 2015之后的版本: 这个安装位置在%LocalAppData%/Microsoft/VisualStudio/14.0/Extensions/******(随机的名称)/ 替换掉里面的AtomineerProDocumentation.dll就好了
PS:如果使用过程中出现路径错误的情况,菜单栏->工具->Atomineer...Trial->...options 进去点下确定出来就好了。 或者进入安装路径找到AtomineerUtilsWizard.exe,通过一下配置向导
安装之后vs中工具一栏 会看见Atomineer Pro Documention Trial 一般选择第一栏 Add/Updata DocComment 就能在指定位置生成注释
通过C#文档注释生成的XML文件来生成帮助文档的。因此,第一步就是生成XML文档:右击项目属性 找到 生成 将下面的xml文档文件勾选,保存,编译,然后在项目的bin\Debug目录下你就会看到生成的xml文件:
生成chm文档工具介绍 Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为我们提供完美的.NET类库文档成为一个可能。
Sandcastle:http://sandcastle.codeplex.com/,点击右侧的download Sandcastle Help File Builder:http://shfb.codeplex.com/
在SHFB的压缩包里我发现了一个VS插件,因此接下来我就打算用VS来演示,如果不想装这个插件的话,可以运行C:\Program Files (x86)\EWSoftware\Sandcastle Help File Builder\SandcastleBuilderGUI.exe这个程序,结果都是一样的
打开VS,新建项目:模板选择Documention 选择第一个 Sandcastle Help File Builder Project
找到Documentation Sources 添加 选择要生成文档的程序集(对应的XML会自动添加),
右击项目选择属性: 选择Help File 有一些属型比如说标题啊, 帮助文档名字啊,语言啊可以选择或更改。
接下来生成项目。如果在生成的过程中没有错误的话,那么在项目目录的Help文件夹下你就会看到:.chm的文件
有时候文件打开会显示 网页显示错误的界面,有两个方法: 1、右击文件属性,有接触锁定的字样,点击就可以了。 2、如果文件存在的路径有“#”这种符号,就会打不开,只需要换个地方就能打开了。