构建 Visual Studio 项目时构建 Sandcastle 文档

发布于 2024-12-11 10:31:08 字数 153 浏览 0 评论 0原文

我正在使用 Sandcastle 帮助文件生成器将我的 C# XML-DOC 文件输出为网站格式。如何从命令行完成相同的操作，以便在构建实际项目时将其添加为 Visual Studio 中的构建事件？

最终目标是在构建 Visual Studio 项目时构建网站帮助文件内容。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

于我来说 2024-12-18 10:31:08

正如 Scott Wylie 所指出的，您需要在 Visual Studio 项目属性的构建后事件命令行中指定这一点。但是，我建议使用 Sandcastle 帮助文件生成器 (SHFB)，而不是直接使用 Sandcastle。它使命令行调用变得简短，如下所示，但请注意，首先您必须使用 SHFB GUI 配置 SHFB 项目，这将创建一个带有“.shfbproj”后缀的与 msbuild 兼容的构建文件：

    C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe
        /p:Configuration=Release myProject.shfbproj

但是，请注意，我采用与您正在做的相反的方法：我不使用 Visual Studio 交互式启动构建和辅助操作，而是使用 ant (nant) 启动所有内容的构建，其中包括我的 Visual Studio 解决方案和后续的 SHFB 操作。所以这实际上是我使用 Sandcastle 构建文档时进行的命令行调用：

<exec executable="${msbuild}" dir="${csharpdoc}" output="${csharpdoc.log}">
    <arg value="/p:Configuration=Release"/>
    <arg value="myProject.shfbproj"/>
</exec>

我的偏好是整个构建应该可以从命令行启动，因此不需要交互（例如启动 Visual Studio 等）。这提供了作为计划的重复任务运行或从 shell 按需运行的灵活性。

As Scott Wylie indicated, you need to specify this in the post build event command line in Visual Studio's project properties. However, I would suggest using Sandcastle Help File Builder (SHFB) rather than Sandcastle directly. It makes the command line call short and simple as shown below, but note that first you have to configure the SHFB project with the SHFB GUI, which creates an msbuild-compatible build file with the ".shfbproj" suffix:

    C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe
        /p:Configuration=Release myProject.shfbproj

However, note that I take the opposite approach from what you are doing: instead of using Visual Studio to interactively launch a build and ancillary actions, I use ant (nant) to launch a build of everything, which includes my Visual Studio solutions and subsequent SHFB action. So this is really the command-line call I make to build the documentation with Sandcastle:

<exec executable="${msbuild}" dir="${csharpdoc}" output="${csharpdoc.log}">
    <arg value="/p:Configuration=Release"/>
    <arg value="myProject.shfbproj"/>
</exec>

My preference is that the entire build should be launchable from the command line so there are no interactions required (e.g. launching Visual Studio, etc.). That provides the flexibility to run either as a scheduled recurring task or on-demand from the shell.

回复收藏 0 原文