自动生成.NET项目帮助生成

工具

1. 先安装Sandcastle生成帮助文档安装.msi

2. 再安装HTML Help Workshop

3. 最后安装DocProject-1110RC1.exe

4. 然后会在VISUAL STDIO 中新建项目的模板中看到docproject(Creates a class library project that builds a single compiled help file for all of its project references; extensibile using a C# build process component)clip_image002

5. 添加这个项目

6. 然后在原来的解决方案中的所有项目-》属性-》生成-》输出》XML文档选项勾选上

a) 自动生成.NET项目帮助生成_第1张图片

7. 添加新的项目DOCPORJECT1

a) 自动生成.NET项目帮助生成_第2张图片 自动生成.NET项目帮助生成_第3张图片 自动生成.NET项目帮助生成_第4张图片 自动生成.NET项目帮助生成_第5张图片 自动生成.NET项目帮助生成_第6张图片 自动生成.NET项目帮助生成_第7张图片

b) 查看项目

c) 自动生成.NET项目帮助生成_第8张图片

d) 编译 生成 这个地方很慢的 20分钟所有 不要停(CTRL+BREAK),特别是第7步,非常的慢

e) clip_image020

自动生成.NET项目帮助生成_第9张图片

完成后 生成CHM 文件 如图所示

自动生成.NET项目帮助生成_第10张图片截图举例 如下:

自动生成.NET项目帮助生成_第11张图片
这里要求 类中的注释 是XML格式 (就是三横线的那种,系统可以直接识别出来)自动生成.NET项目帮助生成_第12张图片

拉出一个 helpProvider 控件,把CHM 放在EXE 同样的目录

然后再菜单下面输入打开帮助的代码

private void helpProfessionMenuItem_Click(object sender, EventArgs e)

{

Help.ShowHelp(ActiveForm, "DocProject1.chm");

}

OK

制作完毕

如果自己要做其他非自动生成的 HTML HELP WORK 直接可以将做好的网页帮助文件生成

你可能感兴趣的:(html,xml,.net,文档,library,chm)