问题标签 [sandcastle]

有没有一种从 Visual Studio XML 输出生成 MSDN 样式文档的简单方法？
我没有足够的耐心来为它设置一个好的 xslt，因为我知道我不是第一个跨过这座桥的人。

另外，我最近尝试设置沙堡，但它确实让我的眼睛交叉。要么我在这个过程中遗漏了一些重要的东西，要么就是太投入了。

我知道有人有一个非常好的非常简单的解决方案。

我在这里重申，因为我认为我的格式使该段落不宜阅读：

我尝试了沙堡，但设置起来非常困难。我真正想到的是更简单的事情。

也就是说，除非我只是不了解沙堡过程。对我来说，仅仅为测试人员提供一些可以使用的好东西，这似乎是一大堆额外的包袱。

我正在尝试为网站生成 Sandcastle 帮助文件。在项目的属性窗口中，没有任何用于创建 Sandcastle 所需的 XML 文档文件的选项。

属性页中的构建选项卡仅包含以下选项：开始操作、构建解决方案操作和可访问性验证。我没有任何输出选项或 XML 文档文件，就像我的其他项目一样。

我正在使用的网站没有实际的 .proj 文件，这可能是问题所在。如果这是问题所在，那么为一个受源代码控制并由许多人进行工作且干扰最小的项目创建一个的最佳方法是什么？

这是使用 Visual Studio 2005 专业版。

在工作中，我们使用 Sandcastle 来创建帮助文件。我使用 SandCastleGUI 已经有一段时间了，我正在寻找一种在帮助文件中创建其他页面的方法。这些页面以称为 MAML 的 XML 格式编写。唯一的问题是我找不到适合这些文件格式的任何合适的编辑器。

我正在寻找一个所见即所得的编辑器来创建和编辑其他文档页面。

前段时间我开始使用Sandcastle为我们的一个项目生成一个文档网站。它运行良好，但我们一直只为项目中的类、方法、属性（...）编写文档，并且为整个项目和项目部分/模块/命名空间提供完全独立的文档。如果我可以将该文档合并在一起并将相应的文档添加到生成的帮助文件中，那就太好了，但我不知道该怎么做。

只是在命名空间声明中添加注释似乎不起作用（C#）：

有谁知道如何做到这一点？我知道这是有可能的，如果能拥有... :)

我需要采取哪些步骤才能通过 Visual Studio 中的构建步骤自动构建 HTML 文档？我有所有的评论和正在生成的 comments.xml 文件，并安装了 Sandcastle。我只需要知道要在构建后步骤中添加什么来生成文档。

对于 delphi 代码，我需要一个类似于 javadoc 或 c# xml doc 的代码文档工具。什么是最好的工具？我更喜欢一种技术，它在未来与微软沙堡项目兼容。

我需要

1. 将作为网站 (HTML) 的 Sandcastle 帮助文件生成器 (SHFB) 输出转换为媒体 wiki 格式
2. 找到一种方法将转换后的页面直接传输/包含到我们设置的 MediaWiki 中。

有任何想法吗？我们在网站上有超过 1000 页的 HTML 文件（SHFB 的输出）。

我想过使用 html2wiki 转换器..我可以考虑寻找一个脚本来将这 1000 个页面转换为 wiki 格式......这可以解决 (1)。

但是我仍然会在管道的最后一位中留下块 - 如何将转换后的页面直接输入 Wiki？

您的 .NET 源代码中有多少代码文档太多了？

一些背景：我继承了我在 SO 上发布的其他一些问题中谈到的大型代码库。该代码库的“特性”之一是 God Class，它是一个具有超过 3000 行代码的单个静态类，包含几十个静态方法。这是从Utilities.CalculateFYBasedOnMonth()到Utilities.GetSharePointUserInfo()到的一切Utilities.IsUserIE6()。这都是不需要重写的好代码，只需重构为一组适当的库。我已经计划好了。

由于这些方法正在进入一个新的业务层，而我在这个项目中的角色是准备系统以供其他开发人员维护，我正在考虑可靠的代码文档。尽管这些方法都具有良好的内联注释，但它们并不都具有 XML 注释形式的良好（或任何）代码文档。使用 GhostDoc 和 Sandcastle（或 Document X）的组合，我可以创建一些非常漂亮的 HTML 文档并将其发布到 SharePoint，这将使开发人员无需浏览代码本身就可以更多地了解代码的作用。

随着代码中文档数量的增加，导航代码变得越困难。我开始怀疑 XML 注释是否会使代码更难维护，比方说，//comment每个方法都更简单。

这些示例来自 Document X 示例：

和：

所以我想问您：您是否使用 XML 注释来记录您的所有代码，目的是使用 NDoc (RIP) 或 Sandcastle 之类的东西？如果没有，您如何决定哪些获取文档，哪些不获取？像 API 之类的东西显然会有 doco，但是你要交给另一个团队来维护的代码库呢？

你觉得我应该怎么做？

我的团队负责为我们编写的大型系统开发 API。我们需要提供示例代码，以便其他使用我们 API 的开发人员可以学习如何使用它。我们一直在使用 xml 文档注释记录代码。例如。

然后我们使用 Sandcastle 并构建我们需要的帮助文件（chm 和一个在线网站）。

当示例代码不起作用时，这是相当尴尬的，这通常是因为某些功能发生了变化或一个简单的错误。

有没有人做过这样的事情，而且还配置了单元测试以在示例代码上运行，以便知道它们在构建期间可以工作？

我有几个 C# 项目以及一些我试图一起记录的内部库组件。Sandcastle 似乎是从 C# 生成文档的地方。我想知道 DocProject 或 Sandcastle Help File Builder GUI 两者中的哪一个更好并且支持我需要的功能。

我想只编译每个项目自己的文档部分，然后最后将它们全部集成在一起。（即一个文档项目中的库组件和它自己的文档项目中的每个项目，然后使用 Help 2 查看器将上述所有内容放在一个根目录中）