c# - 使用 Markdown 编写源代码文档

Question

我正在寻找 C# 的 XML 源代码文档的替代品，由于 XML 的本质，它引入了很多噪音，这对眼睛来说很沉重，而且需要编写更多的工作:

/// <summary>
/// This is text of importance. Linking to
/// <see cref="AnotherClass>is somewhat verbose.</see>
/// </summary>
/// <param name="andSo">is parameter documentation</param>

相反，我想在文档中使用 Markdown:

/// This is text of importance. Linking to [an](OtherClass) is less verbose.
/// 
/// Empty lines would make a new paragraph
///
/// aParameter
/// :    could possibly be documented in definition-list manner
///      as in http://bit.ly/1l9ik26

我可以打赌我之前在 Stackoverflow 上找到了一个问题和答案。不幸的是，我再也找不到它了。我尝试了所有我能想到的搜索关键字变体，但没有成功。所以我希望你们中的任何人都能找到副本。至少我的问题会通过使用不同的措辞为现有的问答提供“代理”来为 SO 增加一些值(value)，从而提高 future 访问者找到他们信息的几率。

更新:

我想我终于通过使用不同的搜索引擎找到了另一个问题:Markdown for automatic doc generation? .看来 Doxygen 支持 Markdown。 Doxygen 也支持 C#。但是对于@Sam Harwell 提到的要求，这可能不会有太大帮助。

Answer 1

这个要点很好地完成了工作:https://gist.github.com/formix/515d3d11ee7c1c252f92

生成的文档如下所示:https://github.com/formix/MegaCityOne/blob/master/MegaCityOne/doc/api.md