如何在文檔註釋中使用自定義鏈接文本創建代碼引用？

我正在將應用程序庫從Java移植到C＃。在Java文檔中，有些地方使用自定義文本鏈接到特定的代碼引用。例如：如何在文檔註釋中使用自定義鏈接文本創建代碼引用？

Suffix --&gt; {@link DataOutput#writeString String}

我使用XML文檔註釋類似的方法試過......

Suffix --&gt; <see cref="DataOutput.WriteString(string)">String</see>

...但整個鏈路只是從兩個智能感知和生成的文檔消失時，我嘗試它那樣。問題是，如何使用C＃中的.NET XML文檔註釋來構建具有自定義文本的類似代碼鏈接？如果無法執行此操作，建議的解決方法是什麼？

如果重要，我們正在試驗使用DocFx代碼生成器。

來源

2017-06-21 NightOwl888

看一看沙堡，它能夠從你的XML的文檔生成HTML-幫助文檔（除了一些人也）。但是VS不能像Eclipse那樣處理到其他類型或成員的鏈接。 – HimBromBeere

DocFX支持這些註釋以生成鏈接。它也用於其源代碼，如[this]（https://github.com/dotnet/docfx/blob/1a191f6f1853e48873d5f45003cda669d3df0cca/src/Microsoft.DocAsCode.Dfm/IDfmEngineCustomizer.cs#L11）。引用的方法是否也由DocFX構建？ – Yuby

@Yuby - 您引用的鏈接有一個*標準代碼鏈接*，它使用代碼元素的名稱作爲鏈接文本（在本例中爲'DfmEngineBuilder'）。我所問的是將鏈接文本變成除引用的代碼元素的名稱以外的內容，例如「我的自定義文本」（因爲它是在正在移植的代碼中以這種方式完成的）。 – NightOwl888

您可以使用DocFX的交叉引用語法：[String](xref:DataOutput.WriteString(System.String))。

參見：http://dotnet.github.io/docfx/tutorial/links_and_cross_references.html#different-syntax-of-cross-reference

來源

2017-07-18 13:49:16 Yuby

或者「@」DataOutput.WriteString（System .String）？文本字符串=「' – bitbonk

如何在文檔註釋中使用自定義鏈接文本創建代碼引用？

回答

相關問題