在没有Visual Studio的情况下从代码内XML文档生成C#docs输出?

时间:2017-11-06 04:39:10

标签: c# xml visual-studio documentation

如果不构建项目,是否可以只扫描代码并获取三重斜杠的代码文档并输出它们? (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可以读取它,我想可能还有其他程序不是可以从中生成doc输出的完整Visual Studio。 (无论是XML还是Markdown)

我想自动生成Slate

的输入

1 个答案:

答案 0 :(得分:0)

最后,我使用Visual Studio社区来获取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