Ich portiere eine Anwendungsbibliothek von Java nach C#. In der Java-Dokumentation gibt es Orte, die mit benutzerdefiniertem Text auf einen bestimmten Code verweisen. Zum Beispiel:Wie erstellen Sie Codereferenzen mit benutzerdefiniertem Linktext in Dokumentationskommentaren?
Suffix --> {@link DataOutput#writeString String}
ich in XML-Dokumentation Kommentaren Einen ähnlichen Ansatz versucht, mit ...
Suffix --> <see cref="DataOutput.WriteString(string)">String</see>
... aber der ganzen Link verschwindet nur von beiden Intellisense und der erzeugten Dokumentation, wenn ich es versuchen dieser Weg. Die Frage ist, wie konstruiere ich ähnliche Codelinks mit benutzerdefiniertem Text mit .NET XML-Dokumentationskommentare in C#? Wenn es keine Möglichkeit gibt, dies zu tun, was ist die empfohlene Problemumgehung?
Wenn es darauf ankommt, experimentieren wir mit dem Code-Generator DocFx.
Werfen Sie einen Blick auf Sandburg in der Lage ist HTML-Hilfe-Dateien zu erzeugen (abgesehen auch einige andere) aus dem xml-docs. Allerdings ist VS nicht in der Lage, Links zu anderen Typen oder Membern zu bearbeiten, wie es zum Beispiel Eclipse tut. – HimBromBeere
DocFX unterstützt solche Kommentare zum Generieren eines Links. Es wird auch in seinem Quellcode wie [this] (https://github.com/dotnet/docfx/blob/1a191f6f1853e48873d5f45003cda669d3df0cca/src/Microsoft.DocAsCode.Dfm/IDfmEngineCustomizer.cs#L11) verwendet. Wird die referenzierte Methode auch von DocFX erstellt? – Yuby
@Yuby - Der Link, auf den Sie verwiesen haben, hat einen * Standardcode-Link *, der den Namen des Codeelements als Linktext verwendet (in diesem Fall 'DfmEngineBuilder'). Worum ich bitten möchte, ist, den Linktext in etwas anderes als den Namen des Codeelements zu bringen, auf das verwiesen wird, z. B. "Mein benutzerdefinierter Text" (da dies in dem Code, der portiert wird, so gemacht wurde). – NightOwl888