我如何学习为Visual Studio项目编写帮助文件？ [英] How do I learn to write help files for my visual studio projects?

问题描述

我已经编写了几个visual studio 2012项目，我想为其编写帮助文件。我从哪里开始？我需要考虑哪些事项？我需要什么工具，他们是免费的吗？



我尝试过：



网络搜索visual studio 2012帮助编译器

I have written a couple of visual studio 2012 projects that I would like to write help files for. Where do I start? What things do I need to consider? What tools would I need and are they free?

What I have tried:

A web search for visual studio 2012 help compliers

推荐答案

SubMain / GhostDoc - 无痛帮助文档 [ ^ ]

GhostDoc将帮助您创建XML文档文件。如果你想把它们变成一个合适的帮助文件，你需要像Sandcastle帮助文件生成器这样的东西：

GitHub - EWSoftware / SHFB：Sandcastle帮助文件生成器（SHFB）。独立的GUI，Visual Studio集成包和MSBuild任务，提供使用Sandcastle工具构建帮助文件的完整配置和可扩展性。 [ ^ ]

GhostDoc will help you create the XML documentation files. If you want to turn them into a proper help file, you'll need something like Sandcastle Help File Builder:
GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.[^]

这篇关于我如何学习为Visual Studio项目编写帮助文件？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！