MS Sandcastle - 有没有快速“预览”的方法如果不重新编译整个帮助,输出会是什么?

发布于 2024-11-19 15:55:10 字数 209 浏览 2 评论 0原文

好吧,标题已经说明了一切。

我有 Sandcastle 帮助文件生成器 GUI。我可以生成帮助文件,但我想知道除了重新编译整个帮助文件之外是否有更快的方法来查看结果。


我询问了 Sandcastle,因为我尝试过的其他提供预览功能的工具不像 Sandcastle 那样将帮助文件编译为准确的规范。他们中的大多数都需要完全合格的参考资料,这是一件令人痛苦的事情。

Well, the title asks it all.

I have the Sandcastle Help File Builder GUI. I can generate help files, but I was wondering if there was a faster way of seeing the results aside from recompiling the entire help file.


I asked about Sandcastle because other tools I've tried that offer a preview feature don't compile help files to the exact specification as does Sandcastle. Most of them require fully qualified references, which is a pain in the butt.

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

扫码二维码加入Web技术交流群

发布评论

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

评论(2

花开雨落又逢春i 2024-11-26 15:55:10

不,没有预览功能,但有一些 SHFB 设置可以让您显着缩短构建时间。就我而言,我的 16 到 18 分钟的构建时间减少到了 3 分钟。

您要调整的是 缓存构建组件。不用担心,调整这 3 个组件不需要神秘的操作或复杂的旋转。

  1. 只需转到 SHFB GUI 中的 Build 部分,然后找到顶部附近标记为 ComponentConfigurations 的行。
  2. 单击值字段可显示隐藏的省略号 (...) 按钮。
  3. 单击该按钮可打开选择和配置构建组件对话框。
  4. 依次选择以 Cached... 开头的三个条目,然后选择“添加”操作。
  5. 这些不需要配置,因此关闭对话框,如果成功,主 SHFB 窗口现在应该指示 3 个自定义构建组件

请务必查看上述链接中的文档以了解更多详细信息。

为了完整起见,还有另外两个感兴趣的项目:

看看这个论坛帖子 (Sandcastle 构建需要几个小时才能完成),讨论您的硬件如何对 Sandcastle 构建时间产生巨大影响。

看看我的文章 Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code(位于 Simple-Talk.com),讨论了 Sandcastle 的大量技巧和陷阱,以及SHFB——讽刺的是,在那篇文章付印后,我在这里发现了关于缓存构建组件的技巧,所以你不会在那里找到它!

No, there is no preview capability but there are some SHFB settings that allow you to dramatically reduce build time. In my case, my 16 to 18 minute build was reduced to 3 minutes.

What you want to adjust are the Cached Build Components. And fear not, adjusting these 3 components requires no arcane manipulations or complex gyrations.

  1. Simply go to the Build section in the SHFB GUI, and find the line near the top labeled ComponentConfigurations.
  2. Click on the value field to reveal a hidden ellipsis (...) button.
  3. Click that button to open the Select and Configure Build Components dialog.
  4. Select in turn each of the three entries beginning Cached... and select the Add action.
  5. These require no configuration so close out the dialog and if successful the main SHFB window should now indicate 3 custom build component(s).

Be sure to review the documentation at the above link for more details.

Just for completeness, two other items of interest:

Take a look at this forum post (Sandcastle build is taking hours to complete) that discusses how your hardware can have a tremendous impact on Sandcastle build time as well.

Take a look at my article Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Code on Simple-Talk.com that discusses quite a lot of tips and pitfalls of Sandcastle and SHFB--ironically I uncovered my tip here about cached build components after that article went to press so you will not find it in there!

丶情人眼里出诗心の 2024-11-26 15:55:10

在 SandCastle GUI 中,转到菜单“窗口”并打开“主题预览器窗口”。

如果您安装了 Visual Studio 和 Sandcastle VSiX 扩展,请转到 Visual Studio 菜单“查看”>“其他窗口并单击“主题预览器窗口”。

请参阅 https://ewsoftware.github.io/SHFB/html/d3c7584d-73c0-4725-87f8-51e4ad956694.htm

In SandCastle GUI, go to menu Window and open Topic Previewer Window.

If you have Visual Studio and the Sandcastle VSiX extension installed, go to the Visual Studio menu View > Other Windows and click on Topic Previewer Window.

See https://ewsoftware.github.io/SHFB/html/d3c7584d-73c0-4725-87f8-51e4ad956694.htm.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文