如何从XML文档注释创建网站？

Question

我想从C＃XML documentation comments创建一个文档网站。

Python社区的一个例子。此Scipy documentation是使用名为python code的工具从此Sphinx创建的。

C＃项目是否可以这样？

---

.NET项目（不是我的）https://github.com/haf/NodaTime/blob/master/src/NodaTime/Period.cs#L26

中的XML文档注释示例

/// <summary>
/// Represents a period of time expressed in human chronological terms: hours, days,
/// weeks, months and so on. All implementations in Noda Time are immutable, and return fields
/// in descending size order: hours before minutes, for example.
/// </summary>
public sealed class Period : IEnumerable<DurationFieldValue>, IEquatable<Period>

---

编辑：我在其他问题中可以找到的全部建议是“使用Sandcastle”。据我所知（具有讽刺意义的）文档，它只能创建Windows帮助文件（.chm）。那是对的吗？

Answer 1

  

编辑：我在其他问题中可以找到的全部建议是“使用Sandcastle”。据我所知（其具有讽刺意味的是）文档，它只能创建Windows帮助文件（.chm）。这是对的吗？

不，那不对。 Sandcastle可以构建广泛的输出。

然而，这些天你真的想要Sandcastle Help-File Builder (SHFB)，这会让事情变得更好。仍然不是完全无痛，但相当不错。 SHFB的文档通常也很合理。

有趣的是你应该举一个Noda Time的例子 - SHFB正是我们用来生成online API reference的。

Answer 2

您也可以尝试sharpDox。另一个免费的开源文档生成器。 您可以创建html和chm输出，很快就会生成单词文档。

以下是html output的示例。

P.S。：我是这个工具的创造者。

Answer 3

对于一键式解决方案，您还可以尝试我们的VSdocman。