问题标签 [sandcastle]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
1032 浏览

c# - 如何在沙堡 xml 文档构建中排除不可浏览的成员

我希望能够排除那些虽然是公共的,但用 EditorBrowable.Never 装饰的成员。

我在选项中看不到任何地方可以做到这一点。是否有可以指定要排除的属性的插件?

0 投票
4 回答
2155 浏览

.net - SandCastle 是一个死项目吗?

微软在发布 Sandcastle 的 CTP/Beta 版本时杀死了 NDoc,我很少看到有关可用版本 Sandcastle 的新版本的信息(例如,带有集成 UI)。最新版本是 2008 年 5 月的版本。Sandcastle 是死项目还是会包含在 Visual Studio 2010 中?

0 投票
1 回答
1372 浏览

visual-studio - 将 VS2008 中的类图添加到 Sandcastle 帮助文件

我在 Visual Studio 2008 Team System 中为我的项目制作了类图,我想将这些图嵌入到我的 Sandcastle .chm 文件中。我一直在寻找对 Sandcastle吊桥组件的引用,但他们显然处理的是旧版本的 Sandcastle;这并不奇怪,因为 Drawbridge 的最后一次更新似乎是在 2008 年。对于我在 Vista 中使用的 Sandcastle 当前版本,它安装在 C:\Program Files\Sandcastle Help File Builder 中。安装 Drawbridge 后,它创建了以下目录结构:C:\Program Files\EWSoftware\Sandcastle Help File Builder\BuildComponents。然后它将一个 XML 组件配置文件放在那里,但这当然对我安装的 Sandcastle 版本没有任何意义,因为它不在其路径中的任何位置。

我希望只是将 XML 配置文件复制到 Sandcastle 的当前安装目录,但那里没有 BuildComponents 目录。那么,有谁知道 Drawbridge 是否仍然与 Sandcastle 一起使用?如果是这样,我该如何安装它?如果没有,我如何在我的 Sandcastle .chm 帮助文件中嵌入 VS2008 类图?

这与这个问题略有关系。

0 投票
1 回答
212 浏览

.net - SandCastle 上的 MRefBuilder 无效字符异常

我正在尝试使用 Sandcastle 帮助文件生成器为我的程序集生成帮助文件。当我运行构建时,我收到以下错误:

从命令行运行时,我也会收到此错误。

我使用十六进制编辑器检查了 VS 输出的 Documentation.xml,文件中没有字符 0x02。

有没有人有任何线索或建议?

谢谢

0 投票
1 回答
2374 浏览

c# - 使用 Sandcastle 记录:使用枚举值引用

我正在使用 Sandcastle 2.4.10520 和 Sandcastle Help File Builder 1.8.0 来生成 .chm 帮助文件。

在我的文档中,我使用了<see>标签。

如果我尝试引用一个枚举,<see cref="NumberStyles"/>它就可以完美地工作。

如果我尝试引用一个枚举值,例如<see cref="NumberStyles.AllowTrailingWhite"/>在文档文件中获得一个链接,但该链接将我引导至未找到的 MSDN 页面

我没有收到任何警告 - 我的 xml 文档是正确的。

我注意到引用枚举值的 MSDN 页面也有一个 Page not found 链接。例如:UInt64.Parse Method (String, NumberStyles, IFormatProvider)引用NumberStyles.AllowHexSpecifier,这会导致另一个MSDN Page not found

我应该引用枚举而不是枚举值吗?

我应该怎么做才能引用枚举?甚至可能吗?

0 投票
1 回答
1614 浏览

c# - XML 文档中的多语言示例

有没有办法在 XML 文档中包含多种语言(例如 C# 和 Visual Basic)的示例?

我正在使用 SandCastle 构建 MSDN 样式的文档,并希望包含一些 .NET 语言的使用示例。

0 投票
4 回答
4487 浏览

visual-studio-2010 - 在 Visual Studio 2010 .NET 4.0 项目中使用沙堡帮助构建器构建时出错

我在 Visual Studio 2008 中使用 Sandcastle 为我的项目生成帮助。当我将项目更改为 Visual Studio 2010 并将项目 .NET 版本更改为 .NET 4.0 时,我遇到了 Sandcastel 的这个问题。我不明白为什么 sandcastel 使用 C:\Windows\Microsoft.NET\Framework64\v3.5\MSBuild.exe 而不是 C:\Windows\Microsoft.NET\Framework64\v4.0\MSBuild.exe 认为我指定为框架版本 v4.0.30319

谁能告诉我如何解决这个问题??在哪里更改 msbuild.exe 或其他解决方案的路径???

0 投票
1 回答
1684 浏览

.net - Sandcastle 帮助生成器 - 未找到 SandcastleBuilder.Components.ShowMissingComponent'

注意:也发布在 Sandcastle Help Builder 网站上。

我收到了这个错误:

BUILDASSEMBLER:错误:BuildAssembler:在组件程序集“C:\Program Files\EWSoftware\Sandcastle Help File Builder”中找不到类型“SandcastleBuilder.Components.ShowMissingComponent”

我检查了(可见反射器);在那里。卸载并重新安装:

  • 沙堡(版本 2.6.1062.1)
  • 帮助文件生成器(1.8.0.3 发行版)
  • VS 2008 SDK 1.1

仍然出现错误。请注意日志中的此警告:SHFB: Warning BE0004: MRefBuilder has a version of '2.6.10621.1' but version '2.4.10520.1' is expected. 您可能需要更新帮助文件生成器的副本。

任何帮助都会得到帮助。

谢谢,英国石油公司

0 投票
1 回答
1152 浏览

doxygen - 是否可以将 SandCastle 与 Visual Studio 2008 和 C++(非 CLI)一起使用?

我很困惑:我正在使用带有 C++(非 CLI)的 Visual Studio 2008,但我终其一生都无法弄清楚如何使用 Sandcastle 构建帮助文件。

一旦安装并生成一个 .xml 文件,是否应该在某处有一个菜单选项来打开文档的构建?或者至少有一个菜单选项来触发文档的构建?

0 投票
3 回答
6957 浏览

visual-studio-2010 - Visual Studio 2010 有沙堡插件吗?

我真的很喜欢在我的项目中使用 SandCastle 生成的帮助文件... 是否有适用于 SandCastle 的 Visual Studio 2010 插件,或其他与 Visual Studio 直接集成的不错的替代程序?