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

Col*_*nic 6 .net c# documentation

我想从C#XML文档注释创建一个文档网站.

Python社区的一个例子.这个Scipy文档是使用名为Sphinx的工具从这个python代码创建的.

这样的C#项目有可能吗?


.NET项目中的XML文档注释示例(不是我的)https://github.com/haf/NodaTime/blob/master/src/NodaTime/Period.cs#L26

/// <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>
Run Code Online (Sandbox Code Playgroud)

编辑:我在其他问题中可以找到的全部建议是"使用Sandcastle ".据我所知(其具有讽刺意味的是)文档,它只能创建Windows帮助文件(.chm).那是对的吗?

Jon*_*eet 6

编辑:我在其他问题中可以找到的全部建议是"使用Sandcastle".据我所知(其具有讽刺意味的是)文档,它只能创建Windows帮助文件(.chm).那是对的吗?

不,那不对.Sandcastle可以构建广泛的输出.

但是,现在你真的想要Sandcastle帮助文件生成器(SHFB),它可以让事情变得更好.仍然不是完全无痛,但相当不错.SHFB的文档通常也很合理.

有趣的是你应该举一个Noda Time的例子 - SHFB正是我们用来生成我们的在线API参考.