タグ付けされた質問 「xml-documentation」

xmlドキュメントを作成する場合は<see cref="something">something</see>、もちろん機能するを使用できます。しかし、ジェネリック型を持つクラスまたはメソッドをどのように参照しますか？ public class FancyClass<T> { public string FancyMethod<K>(T value) { return "something fancy"; } } どこかでxmlドキュメントを書くつもりなら、どうすればファンシークラスを参照できますか？どうすれば参照できFancyClass<string>ますか？メソッドはどうですか？ たとえば、別のクラスで、のインスタンスを返すことをユーザーに通知したかったのFancyClass<int>です。どうすればそのためにcrefを見ることができますか？

198 c#  generics  reference  xml-documentation 

これはもっと簡単になるはずです... コード内のXMLドキュメントに「コード化された」改行を追加したい /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with icon-tokens, which /// could be used to represent the search in a condensed pictogram format. /// </summary> ご覧のとおり、<と>の括弧の追加を示すいくつかの回答が見つかりました。興味深いことに、良い 'ol <br …

196 c#  .net  xml-documentation 

XmlDocをWeb Apiプロジェクトに統合できるようにするためのドキュメントは、すべてのAPIタイプがWebApiプロジェクトの一部である状況のみを処理するように見えます。特に、XMLドキュメントを再ルーティングして、App_Data/XmlDocument.xmlそのファイルを使用する構成内の行のコメントを外す方法について説明します。これは暗黙的に1つのプロジェクトのドキュメントファイルのみを許可します。 ただし、私のセットアップでは、リクエストとレスポンスのタイプを共通の「モデル」プロジェクトで定義しています。つまり、次のようなエンドポイントが定義されている場合、 [Route("auth/openid/login")] public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { ... } どこにOpenIdLoginRequestそのような個別のC＃プロジェクトで定義されます。 public class OpenIdLoginRequest { /// <summary> /// Represents the OpenId provider that authenticated the user. (i.e. Facebook, Google, etc.) /// </summary> [Required] public string Provider { get; set; } ... } XML doccommentsにもかかわらず、requestエンドポイント固有のヘルプページ（つまりhttp://localhost/Help/Api/POST-auth-openid-login）を表示すると、パラメーターのプロパティにはドキュメントが含まれません。 XMLドキュメントを含むサブプロジェクトの型がWeb API XMLドキュメントに表示されるようにするにはどうすればよいですか？

102 c#  asp.net-web-api  xml-documentation 

休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して、事実と引用で回答できるように質問を更新してください。 2年前休業。 この質問を改善する インターフェースとその実装の間でコメントを自動的に同期する方法はありますか？現在、両方を文書化していますが、手動で同期を維持したくありません。 更新： このコードを考えてみましょう： interface IFoo{ /// <summary> /// Commenting DoThis method /// </summary> void DoThis(); } class Foo : IFoo { public void DoThis(); } このようなクラスを作成すると： IFoo foo=new Foo(); foo.DoThis();//comments are shown in intellisense ここではコメントは表示されません： Foo foo=new Foo(); foo.DoThis();//comments are not shown in intellisense <inheritDoc/>タグは完全に砂の城のドキュメントを生成しますが、それはインテリセンスのツールチップでは動作しません。 あなたのアイデアを共有してください。 …

98 c#  documentation  xml-documentation