0

私はJavaからC#にアプリケーションライブラリを移植しています。 Javaのドキュメントには、カスタムテキストを使用して特定のコード参照にリンクする場所があります。たとえば、次のようにドキュメントコメントにカスタムリンクテキストを使用してコードリファレンスを作成するにはどうすればよいですか?

Suffix --> {@link DataOutput#writeString String} 
私はXMLドキュメントコメントでも同様のアプローチを使用してみました

...

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

...しかし、私はそれをしようとすると、全体のリンクがちょうどインテリセンスと生成されたドキュメントの両方から消えますそうですね。質問は、C#での.NET XMLドキュメントのコメントを使用して、カスタムテキストと同様のコードリンクを構築するにはどうすればいいですか?それを行う方法がない場合は、推奨される回避策は何ですか?

問題が発生した場合は、DocFxコードジェネレーターを使用して実験しています。

+0

は、XML-ドキュメントからHTML-HELPFILES(もさておき、いくつかの他のもの)を生成することができるサンドキャッスルを見てください。しかし、VSは他の型やメンバーへのリンクを処理することはできません。 – HimBromBeere

+0

DocFXはリンクを生成するためのこのようなコメントをサポートしています。また、[this](https://github.com/dotnet/docfx/blob/1a191f6f1853e48873d5f45003cda669d3df0cca/src/Microsoft.DocAsCode.Dfm/IDfmEngineCustomizer.cs#L11)のようなソースコードでも使用されています。参照されるメソッドはDocFXでも構築されていますか? – Yuby

+0

@Yuby - あなたが参照したリンクには、コード要素の名前をリンクテキスト(この場合は 'DfmEngineBuilder')として使用する*標準コードリンク*があります。私が尋ねるのは、リンクされたテキストを 'My Custom Text'のような参照されるコード要素の名前以外のものにすることです(移植されているコードでそのように行われたためです)。 – NightOwl888

答えて

関連する問題