问题标签 [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 投票
2 回答
269 浏览

c# - 如何从 aspdotnet Web 项目生成纯 HTML 文档?

我已经用适当的 ms xml 文档标签注释了所有代码。如何为所有注释代码生成纯 HTML(或 pdf)文档?我已经下载了沙堡,但不知道如何进行下一步。谢谢!

0 投票
1 回答
1015 浏览

c# - 沙堡设置 - 导航到网页已取消

我正在尝试使用 Sandcastle 帮助文件生成器,但无法让它正常工作。这是我所做的:

1)安装程序;正常工作

2) 在项目中启用 xml 我希望在 /bin 中生成相关文档

3)创建了一个新的sandcastle帮助文件项目

4) 将 C# 项目添加为(如果重要,它是 WCF 服务)文档服务

5)运行“构建”以生成帮助文件

6) 在 GUI 中转到“文档”/“查看帮助文件”/“查看帮助文件”

7)文件打开并包含适当的“文件夹”,但每个页面都显示“导航到网页已取消”

我在 /bin 中看到了 xml 文件,它包含了我所有的 /// 注释,那么为什么它们没有出现在帮助文件中呢?有任何想法吗?

0 投票
1 回答
88 浏览

c# - 您如何知道 Visual Studio 中的哪个项目是最后构建的?

我正在按照这个答案构建沙堡文档:在使用 Sandcastle 构建期间自动生成 html 文档,我需要知道我的解决方案中的哪个项目是最后构建的。我确定我错过了一些非常简单的东西。有没有一种简单的方法可以知道我的项目正在构建什么顺序?

0 投票
1 回答
2293 浏览

wcf - 使用 SandCastle 生成 WCF 文档

我正在尝试使用 SandCastle 为 WCF 服务生成外部文档。我如何告诉 SandCastle 使用 WCF 属性ServiceContract来命名函数和实体,而不是它们在程序集中的名称?

0 投票
1 回答
24877 浏览

documentation-generation - 如何获得 Microsoft HTML Help 2 编译器?

我在哪里可以下载 Microsoft HTML Help 2 编译器(或绑定 SDK)?我想使用Sandcastle 帮助文件生成器从我的编程项目中生成 HTML 2 文档,并且 Sandcastle 引导安装向导指示我下载该组件。

摘自 Sandcastle 主页的 HTML 2 节选:

HTML Help 2.x 输出包括一组有效的集合文件和 H2Reg.exe 配置文件,以简化帮助文件的部署和集成到现有集合(例如 Visual Studio 使用的集合)中。

0 投票
1 回答
246 浏览

.net - 如何在 Visual Studio 2008 中集成自己的 API 文档?

我们使用 Sandcastle(帮助文件生成器)创建 API 文档,现在想将它们集成到 Visual Studio 2008 中。如何将 API 集成或添加为外部(Web)资源?

0 投票
5 回答
1054 浏览

wcf - 如何为生成的 WCF 代理类创建 IntelliSense 兼容文档?

我正在尝试将 IntelliSense 和 SandCastle 兼容文档添加到通过 svcutil 生成的 WCF 代理类中。有没有办法在不直接编辑生成的代码的情况下做到这一点(因为如果重新生成它会丢失)?

0 投票
2 回答
4437 浏览

xml - 是否可以使用 Doxygen、Sandcastle 或其他文档生成器记录 XML?

我目前正在使用 Sandcastle、Doxygen 和 JavaDoc 为我编写的代码生成文档。是否可以使用这些包记录 XML 模式?如果没有,是否有任何(最好是免费的!)包可以做到这一点?我可以自己编写文档作为 Doxygen 或 Sandcastle 中的一个额外概念主题,但我宁愿一个工具为我做这件事!

一个例子是(虽然我不是 XML Schema 方面的专家!):

0 投票
1 回答
111 浏览

c# - SandCastle 中的实体文件报告

我使用 SandCastle 来生成我的 C# 项目的文档。默认情况下,我有 chm-file 作为 SandCastle 工作的结果。但我想要一个包含我所有班级描述的 html 文件。我不需要在文档的各个部分之间导航,但我需要一份带有完整文档的可靠文档

0 投票
1 回答
2028 浏览

documentation - 如何在不更改默认安装文件的情况下修改 Sandcastle 演示样式

我的项目使用 Sandcastle 和 Sandcastle Help File Builder 来生成文档。

我们正在使用自定义版本的 script_manifold.js,它可以跨页面保留用户的语言首选项(默认版本会重置每个页面的语言首选项)。

目前,该脚本位于 Sandcastle\presentation\VS2005\scripts 文件夹中。

有没有办法用自定义版本覆盖这个脚本,而不必弄乱 Sandcastle 安装?也就是说,我是否可以将一个文件与我的源代码一起签入源代码控制,并且以某种方式让 SHFB 使用该文件而不是默认的 Sandcastle 文件?