Je porte une bibliothèque d'applications de Java en C#. Dans la documentation Java, il existe des lieux qui sont liés à une référence de code particulière à l'aide d'un texte personnalisé. Par exemple:Comment créer des références de code avec du texte de lien personnalisé dans les commentaires de documentation?
Suffix --> {@link DataOutput#writeString String}
J'ai essayé d'utiliser une approche similaire dans les commentaires de documentation XML ...
Suffix --> <see cref="DataOutput.WriteString(string)">String</see>
... mais le lien tout disparaît juste à la fois IntelliSense et la documentation générée lorsque je l'essayer de cette façon. La question est, comment puis-je construire des liens de code similaires avec du texte personnalisé en utilisant des commentaires de documentation XML .NET en C#? S'il n'y a aucun moyen de le faire, quelle est la solution de contournement recommandée?
Si cela est important, nous expérimentons l'utilisation du générateur de code DocFx.
Jetez un oeil à SandCastle qui est capable de produire du HTML-helpfiles (à part quelques autres aussi) de votre xml-docs. Cependant, VS n'est pas capable de gérer les liens vers d'autres types ou membres comme Eclipse le fait par exemple. – HimBromBeere
DocFX prend en charge ces commentaires pour générer un lien. Il est également utilisé dans son code source comme [this] (https://github.com/dotnet/docfx/blob/1a191f6f1853e48873d5f45003cda669d3df0cca/src/Microsoft.DocAsCode.Dfm/IDfmEngineCustomizer.cs#L11). La méthode référencée est-elle également construite par DocFX? – Yuby
@Yuby - Le lien que vous avez référencé a un * lien de code standard * qui utilise le nom de l'élément de code comme le texte du lien (dans ce cas, 'DfmEngineBuilder'). Ce que je demande à propos de faire le texte du lien dans quelque chose d'autre que le nom de l'élément de code qui est référencé, comme 'My Custom Text' (car il a été fait de cette façon dans le code qui est en cours de portage). – NightOwl888