簡體   English   中英

從不使用Visual Studio的代碼內XML文檔生成C#文檔輸出?

[英]Generate C# docs output from in-code XML documentation without Visual Studio?

如果不構建項目,是否可以僅掃描代碼並獲取代碼中的三斜杠文檔並將其輸出? (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 Code,並且它似乎了解Intellisense中的所有文檔。 我有.sln文件,它似乎鏈接到包含所有信息的程序集。 如果VSCode可以讀取它,我想可能還有其他程序不是可以從中生成doc輸出的完整Visual Studio。 (是XML還是Markdown)

我想自動為Slate生成輸入

最后,我僅使用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

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM