问题标签 [sandcastle]

我在 Visual Studio 2008 中为我的项目制作了类图，并使用 Sandcastle 嵌入了这些图。

例子：

*沙堡文档类库

Biol..::..f_BiolabTestSayisi Method
Biol Class 另请参阅 发送反馈

Biol hastalarının sayısını veren fonksiyon 命名空间：TR.Biol 程序集：TR（在 TR.dll 中）版本：1.0.0.0 (1.0.0.0)

句法

C# 公共静态数据集 f_BiolTestSayisi()

视觉基础

公共共享函数 f_BiolTestSayisi 作为数据集

视觉 C++

公共：静态数据集^ f_BiolTestSayisi()

返回值 [缺少“M:TR.Biol.Biol.f_BioTestSayi”的文档]*

我可以使用 A Sandcastle Documented Class Library 查看项目中的所有类。我也想看看方法原型和正文。我怎么才能得到它？

提前致谢。

任何使用 sandcasle 的人..我都没有发现任何一步一步的向前走来使用它并创建将生成友好帮助文件的 msbuild 项目设置。我从 codeplex 安装它并安装了文件生成器，但他们没有说清楚如何使用它。任何例子都会被应用。

记录依赖属性的最佳方法是什么？

我是否应该将 xml 文档放在字段上：

或在财产上：

还是我真的需要记录（和维护）两者？

沙堡的下载页面在这里。下载 MSI 并安装它会在程序文件 (x86) 中生成一个目录，但启动中没有菜单项，也没有“开始”。评论评论声称解决方案是下载源存档并在其中找到 MSI，但我在源存档中看不到任何 MSI。程序是什么？

我正在尝试使用 SandCastle 为我的最新项目生成一些帮助文档。我的实用程序项目一切正常，但是当我尝试将它与我的主项目一起使用时，它会在 Crystal Reports 上出错。

有谁知道我如何才能完全排除所有 Crystal Reports 文件或某种类型的修复？

我的方法如下

但是当我运行 Sandcastle 时，我的文档最终看起来像这样

用户标识类型：System..::..Int32

[缺少“M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)”的文档]

活动类型：系统..::..Int32

[缺少“M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)”的文档]

ip 类型：System..::..String

[缺少“M:myapp.Core.Domain.ActivityLogService.AddActivity(System.Int32,System.Int32,System.String)”的文档]

我究竟做错了什么？

我希望能够使用 Sandcastle 从现有主题文件 (.AML) 生成帮助文档。我使用 Sandcastle Help File Builder 来协助配置和生成文档。

我不想发布任何代码文档，但是，如果我没有指定文档源（例如，项目、解决方案、dll、exe 等），那么构建将失败。

如何配置 Sandcastle 帮助文件生成器，以便在不暴露代码文档的情况下生成文档？

我正在尝试通过使用 WiX 运行 Sandcastle 帮助文件生成器在构建我的 Sandcastle 项目后创建的 HelpLibraryManagerLauncher 将我自己的帮助文件添加到 Visual Studio 2010 的帮助库中。

我正在使用 WiX 的 QuietExec 自定义操作来运行以下命令：

但是，MSI 安装程序失败并显示以下内容：

查看EventLog，记录如下错误：

这是我的 WiX 代码：

如果我HelpLibraryManagerLauncher从命令提示符运行，它表示操作成功完成，但是当我检查帮助库时，我的帮助库没有安装。

但是，如果我删除该/silent开关，则会弹出通常的帮助库管理器窗口，并列出我的帮助库。

显然，我希望能够从 WiX 自动安装我的帮助文件，而无需与帮助库管理器的 GUI 交互，但我一定遗漏了一些东西。是否可以通过命令提示符或通过 WiX 静默安装帮助文件？（不过，通过命令提示符静默卸载效果很好）。

这CacheLibUnsignedInstallRefusedException也是一个问题。即使未签名，如何让 WiX（和我的 MSI）安装我的帮助文件？

我正在使用 WiX v3.5.2415、Sandcastle v2.610621.1 和 Sandcastle Help File Builder v1.9.1.0。Sandcastle Help File Builder 使用的 Help 2.0 Compiler 和 HTML Help Workshop hhc 可执行文件来自 Visual Studio 2008 SDK。

任何帮助将不胜感激。

我正在寻找一个从我的 VS2010 XML 文档创建 HTML / 帮助文件的好工具。我找到了一些商业工具，例如

• .Net 文档工具
• VSDocman

我相信还有更多，我只是列出这两个作为示例。还有一些简单的 XSLT 样式表可以将 XML 转换为 HTML 文档。

您正在使用什么，例如是否有免费工具来进行转换，可能作为加载项。澄清一下，基本上我找到了两种类型的工具：

1. 将 XML 文档文件转换为不同目标格式的那些，这就是我正在寻找的。
2. 帮助我在源代码中生成 XML 文档的工具。这不是（！）我正在寻找的东西。

谢谢你的帮助。

Sandcastle / SHFB 组合效果很好。感谢所有帮助过的人。

一些备注：

1. NDoc 似乎已经过时了，最后一次更新是从 2005 年开始的。这就是我跳过这个的原因。
2. 一个类似的线程，也非常详细，可以在这里找到：https ://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something-useful感谢您的提示！
3. Sandcastle 有一些来源，我找到的最新版本位于此处：http ://sandcastle.codeplex.com/
4. 为了生成MsHelp2，我必须安装包含hscomp.exe. 有一个版本 1.0 和 1.1，据我所知，版本 1.0 包含编译器。有关详细信息，请参阅Helixsoft和Social MSDN。
5. 在我的情况下，生成的 WebHelp 无法与 Chrome 一起正常工作。它总是重新加载 index.html 页面。
6. 这里的主题展示了如何将命名空间信息添加到沙堡文档中。
7. 2012 年 11 月更新：对于较小的项目，我使用Doxygen - 我发现它更容易配置。

我正在使用 Sandcastle 构建 API 文档。该代码有多个标记为已弃用的类和方法。现在我希望在 API 文档输出中清楚地标记这些方法（划掉或其他标记）。但是，Sandcastle 输出根本没有标记过时的方法/类。

我的问题是。我需要做什么才能让 Sandcastle 标记过时的方法/类。

感谢您的任何建议/帮助。