【问题标题】:Generate C# docs output from in-code XML documentation without Visual Studio?在没有 Visual Studio 的情况下从代码内 XML 文档生成 C# 文档输出?
【发布时间】:2017-11-06 04:39:09
【问题描述】:

如果不构建项目,是否可以仅扫描代码并获取代码中的三斜杠并输出它们? (XML、Markdown 等)

/// <summary>
/// Resume playing of a previously paused audio with fade in length
/// specified by an argument.
/// </summary>
/// <param name="fadeLengthSeconds">Fade out length to use.</param>
public void ResumeFade(float fadeLengthSeconds)
{

目前我正在使用 Visual Studio 代码,它似乎知道我在 Intellisense 中的所有文档。我有.sln 文件,它似乎链接到包含所有信息的程序集。如果 VSCode 可以读取它,我猜可能还有其他程序不是完整的 Visual Studio 可以从中生成文档输出。 (无论是 XML 还是 Markdown)

我想为Slate自动生成一个输入

【问题讨论】:

  • 我会使用 .proj 文件,它是文本文件,而不是 sln 文件。

标签: c# xml visual-studio documentation


【解决方案1】:

最后我使用 Visual Studio Community 只是为了获取 XML 然后使用:

https://github.com/Pxtl/XmlCommentMarkDownGenerator

它是一个 NuGet 包,但用作 CLI 工具。使用mono 在 macOS 上工作,因此您可以在 macOS 中执行exe 文件。

mono PxtlCa.XmlCommentMarkDownGenerator.exe -i ../../Temp/bin/Debug/Assembly-CSharp.xml -o docs.md

【讨论】:

猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2010-10-25
  • 2011-05-02
  • 1970-01-01
  • 1970-01-01
  • 2011-06-04
  • 2011-02-19
  • 2010-11-17
相关资源
最近更新 更多