VS2010 NDoc的插件工具

1、下载Sandcastle Help File Builder:

http://www.codeplex.com/SHFB

2、下载sandcastle:

http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en

1、先安装sandcastle,然后安装sandcastle Help File Builder。接着在使用sandcastle Help File Builder时配置好sandcastle安装路径(选项卡中的Path里的sandcastle Path)。

2、在VS2005/2008环境中选择项目,右击鼠标选属性,切换到Build选项卡,然后把XML File Documentation打钩即可,生成项目。

3、最后在sandcastle Help File Builder菜单:Project-->New Project from Visual Studio..即可导入工程。

已经提供更新了,参考:
http://blogs.msdn.com/b/sandcastle/archive/2010/05/25/sandcastle-version-supporting-vs-2010-net-4-and-microsoft-help-viewer.aspx

下载页面:
http://sandcastlestyles.codeplex.com/releases/view/38144

按说明更新后(就是覆盖旧文件),打开MrefBuilder.exe.config
即在其中加入:
  <supportedRuntime version="v4.0.30319"/> <!-- 4.0 RTM installed by VS2010 RTM -->
这一行配置

因为Sandcastle 2.4.10520的补丁只能支持到RC版本的VS2010/.NET Framework 4,添加这一行即可支持RTM版本。

我已经用过了,成功生成。

实现步骤: 第一:把生成帮助的工程的属性做下修改,右键工程,属性,生成,下面的输出框中有一个生成XML文件选项,打勾。文件会把工程中所有类,方法,属性上的注释保存下来。 第二:启动shfb,然后新建一个工程,名称可以随意指定。这里主要说说几个比较重要的属性设置问题: 1:Documentation Sources,是需要生成详细注释的工程。如果最外层工程有对其它工程的引用,而且我们希望看到所有引用的类,就需要把所有被引用的工程都添加进来。否则用户点击外层类时,被引用的类上面不会有链接,即我们看不到被引用类的内容。 2:References:设置一些工程的依赖项。 3:FrameworkVersion: 选择对应的Framework版本 ,最新版的shfb的默认设置是.net 3.5。 4:HelpFileFormat : 选择需要生成的文档的格式. 这里选定的格式要在下面对应的地方进行设置。对于不同的格式还需要安装不同的编译工具 Helpe1x(chm)需要安装Microsoft HTML Help,Helper2x(Hxs)需要安装 Hxcomp. 5:NamespaceSummaries: 选择需要生成的命名空间,直接点击开窗选择。 6:Lanugages :语言,如果文档中有中文,最好选择中文。 7:CopyrightHref:版权链接,例如http://www.xxx.com/ 8:CopyrightText: 版权文字 ,xx公司所有 9:HelpTitle: 文档标题 10:HtmlHelpName:文档生成文件名称 11:PresentationStyle: 支持vs 2005,Prototype等格式 ,根据自己需要选择 12: OutputPath:生成路径,即最后chm文件存放位置,当然除了CHM还有些其它文件。 13:HtmlHelp1xCompilerPath:可以自定义html help的安装路径。 14:SandcastlePath:可以自定义sandcastel的安装路径。 到此,我们就可以点击软件窗口上的buile the help file按钮,就可以按预期进行生成文档了。如果没有特殊情况,运行期间不会发生任何错误,我们会成功的在输出目录中发现chm文件,但有些情况还是需要注意一下的: 第一:在添加Documentation Sources时,不能在路径中包含.h的字样,例如.Hotel.Host\bin这种路径是不合法的,最后hhc软件会报错。 第二:References项中不能存在重复项。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值