问题标签 [sandcastle]

有谁知道是否可以在已编译的 chm 文件中更改TOC Treeview（紫色书籍）中的图标？SandCastle

我搜索了SandCastle安装文件夹，但找不到这些特定图标。

我现在在想，也许它们是 chm 文档的原生...

我有一个使用xml 注释的 C# 项目。我通过Sandcastle Help File Builder使用Sandcastle从它们制作 chm 文件。该项目中的成员函数之一使用了嵌入式资源。我想在帮助文件中引用它。似乎沙堡不支持这一点，但它解析的 xml 文档文件支持。我这样说是因为下面的例子

如果我编译该代码并从生成的 xml 文档中编译一个 chm，我会在构建日志中得到以下内容：

备注部分是：

如果我按照ReSharper的Agent Smith的建议进行操作并将<see/>元素更改为构建日志会说：<see cref="Resources.TextFile"/>

并且 chm 的备注部分更改为：

所以我的问题是第一部分：

1. 我使用<see/>元素来引用资源是否正确？
2. 有没有办法让沙堡引用它生成的 chm 文件中的嵌入式资源？

我可以通过右键单击表面并选择“将图表导出为图像...”从 Visual Studio 中将类图导出为图像

有没有办法通过命令行来做到这一点？我希望能够将我所有的类图生成为图像，这样我就可以将它包含在我正在使用 Sandcastle 构建的 .chm 中。

我使用sandcastle 为我的项目生成了一个帮助文件，一个.chm 文件。但是只有在我的机器中打开它时才能看到内容。我已经把那个文件给了几个朋友，他们都看不到文件的内容。怎么了？？我该如何解决？我的配置有问题吗？？请帮帮我！

问候，兰加纳。

我正在用注释装饰我的 C# 代码，以便生成 HTML 帮助文件。

我经常声明和记录接口。但是实现这些接口的类可以根据实现抛出特定的异常。

有时，客户只知道他正在使用的接口。我是否应该通过添加可能由其实现者抛出的异常来记录我的接口？

我应该创建/记录自定义异常，以便接口实现者抛出这些而不是框架的那些吗？

我希望这很清楚！

谢谢

编辑 2010 年 1 月 4 日：我决定在http://blog.mikecouturier.com/2010/01/creating-custom-exceptions-in-net-right.html上写一篇关于 .NET 和自定义异常的博客文章

我今天启动了 Sandcastle Help File Builder 来为我的解决方案生成文档，其中包含大约十几个项目。因为我只想为发布版本（不包括我的所有测试项目）生成文档并在之后运行 Sandcastle，所以我在窗口顶部选择了“发布”，就像在 VS 中一样。Sandcastle 会在我的 \bin\release 子文件夹中为每个项目适当地查找生成的 XML 文件。但是，当它找不到我的测试项目的 DLL 时，它会出错。它显然在解决方案文件中看到了这些项目，但没有意识到我在 Release 中没有为它们构建。我尝试在“API Filter”属性中取消选择它们，但这并没有改变任何东西。

我怎样才能让 Sandcastle 忽略这些项目？

我正在使用 Sandcastle Help File Builder 为开源项目构建文档，我面临两个问题：

• 文档内容为法语。我在 SHFB 项目中将语言设置为法语，但生成的大部分文本仍然是英语（“Properties”、“Inheritance Hierarchy”、“See also”...）。我看到 SharedContent 文件夹中有一些本地化文件（实际上并未完全本地化），但它们只允许翻译一些内容，主要是细节（反馈、免责声明、隐私声明等）。如何本地化其余文本？请注意，我有一个英文版的 Visual Studio 2008；这可能是个问题吗？

• 文档以 HTML 格式生成，并将托管在 Linux/Apache 服务器上。不幸的是，Sandcastle 生成的许多文件名的大小写不一致，因此它在 Linux 服务器上不起作用。例如“Index.html”不被 Apache 视为默认文档（它应该是“index.html”），并且由于大小写错误而找不到 CSS 文件......我可以手动修复大小写，但我每次我重建文档时都必须再做一次。该问题是否有已知的解决方案？我想我不是第一个在 Linux 服务器上托管 Sandcastle 生成的文档的人，但我找不到任何有用的信息......

谢谢你的帮助

我们的开发团队目前正在使用 asp.net 2.0，经过大量浏览和跨站点引用后，我发现新的东西是 asp.net MVC，但发现它不能做一些事情，例如支持 asp .net 控件，查看状态。

我不确定除了范式的总体变化之外，其他限制是什么，现在每个页面都将链接到将链接到某个视图的控制器。因此，为了使学习曲线不那么陡峭，我想首先学习 MVP，因为我认为能够取出应用程序和域层并使其可测试已经对我们的整个过程有很大帮​​助没有太多的麻烦。

在浏览了更多之后，我发现 ndoc 现在有点过时了，正在被 sandcastle 取代，它有一个额外的 add in call docproject ，因此应该很好地涵盖了代码中文档的自动生成。

为了处理验收测试，我发现这个工具叫 fittnesse，它应该会有所帮助。

所以对所有这一切都是全新的，我想知道这是否是一个整体的好过程，让这个工具涵盖我们团队的开发过程。并且如果有其他示例/资源/框架覆盖所有这些步骤并且比使用几种工具（即框架）试图弥补差距做得更好？

1. 基本上我的问题是我研究过的工具是否很好地涵盖了我的整个过程？

2. 有没有更好的方法来做 asp.net tdd + 自动文档生成 + 验收测试？

任何建议/反馈表示赞赏。谢谢！！:)

对于项目中的每个类，SandCastle 创建（其中包括）两个页面：

• 主页，称为T_class_full_name，带有描述、语法、继承层次结构和另见
• 成员页面，称为AllMembers_T_class_full_name，带有构造函数、方法、字段等。

有没有办法将这两者合并在一起 -members page附加到主页？

我正在访问一些旧代码，并且有很多事件是手动声明的，而不是使用 EventHandler<T>，如下所示：

一切都很好，直到我开始使用 sandcastle 来记录库，因为它找不到由事件声明生成的私有已添加字段的任何 XML 注释。我想尝试解决这个问题，但我想做的是：

• 让沙堡忽略自动生成的私有字段，而不告诉它完全忽略所有私有字段

或者

• 获取为私有字段生成的 XML 注释

有没有什么方法可以在不重构代码的情况下实现这一点：