問題タブ [xml-comments]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
3 に答える
624 参照

visual-studio - Visual Studioのコメントで<>を使用する方法は?

以下のコメントはVSのxmlコメントの一部ですが、私の問題は、そのような文字が< >xml構造を壊すことです。xmlコメントでそれらをどのように使用できますか?

0 投票する
2 に答える
764 参照

c# - プライベート変数に XML コメントを追加するアドイン

Ghostdoc と同様に、プライベート変数に XML コメントを自動的に追加できる Visual Studio 2008 用のアドインがあります。Ghostdoc や他のほとんどのアドインはプライベート変数をサポートしていません。

0 投票する
3 に答える
763 参照

xml - これは有効な XML コメントですか?

以下のコードは有効な XML ですか?

0 投票する
4 に答える
4154 参照

visual-c++ - Visual Studio 2010 の C++ で XML コメントを有効にする

Visual Studio 2010 で C# および VB の C++ メソッドの XML コメントを有効/実現するにはどうすればよいですか? この機能は、デフォルトでは有効になっていない/利用できないようです。

最初に管理された C++ プロジェクトをターゲットにします。

0 投票する
2 に答える
342 参照

c# - API のセットから別の同様の API のセットに xml コメントをコピーする方法はありますか?

Visual Studio に古いプロジェクトと同じ API をいくつか含む新しいプロジェクトがあり、xml ドキュメントを新しいプロジェクトにコピーしたいとします。手動で 1 つずつコピー アンド ペーストせずにこれを行う方法はありますか?

0 投票する
4 に答える
6244 参照

visual-studio-2010 - VS2010: 自動生成されたファイルと XML ドキュメント

これは、Visual Studio 2008 について尋ねられたこの質問を再質問しているだけです。VS2010 には、自動生成されたコードに対する CS1591 コンパイラの警告を取り除く機能が用意されていますか?

CS1591: Missing XML comment for publicly visible type or member

VS2008 の質問を引用するには:

これは問題というより厄介です。私のプロジェクトには、(mgmtclassgen.exe を使用して) 自動生成された多数のファイルが含まれています。XML ドキュメントを生成すると、美しくコメントされたライブラリが、これらの autogen ファイルからの xml ドキュメントの警告に悩まされます。

a) これらのファイルのドキュメントの生成を抑制する方法、または b) 一連のファイルに対してのみ警告 CS1591 を抑制する方法はありますか? 抑制プラグマを追加するだけでも、自動生成されたファイルを変更したくないことは明らかです。

編集: 私の場合、問題のあるファイルは WCF RIA サービスによって生成されるため、エラーを生成しているファイルは自動生成された WebContext クラス ( MyProject.BusinessApplication.Web.g.cs) です。

このファイルはオンザフライで生成されるため、手動で変更することはできません。すべての変更は消去されます。また、自動生成されていないコードで役立つため、警告をグローバルに無効にしたくありません。

0 投票する
2 に答える
2262 参照

vb.net - Visual Web Developer2010-VB.Netxmlコメントショートカット

うまくいけば、非常に迅速で簡単な答えの質問です。VisualStudioおよびVisualWebDeveloperの以前のバージョンでは、次のような自動生成されたコメントを生成する関数の前の行に3つのアポストロフィ(つまり''')を入力できました。

2010年にこれを行っても同じ効果はないようです。Googleでハンティングを試しましたが、喜びはありません。このショートカットはまだ利用できますか?それは何か他のものに変わりましたか?

ありがとう、スティーブ

0 投票する
0 に答える
252 参照

javascript - ajaxdocの使い方

スクリプトのコメントを生成するためにajaxdocを使用する方法を理解できません。

これについての簡単なチュートリアルまたは例を提供していただければ幸いです。このプロジェクト dll を使用する必要がありますか。

0 投票する
1 に答える
731 参照

visual-studio - デリゲートの上にあるVisualStudio2010の「///」による自動コメント

代理人:VS2010で代理人を入力すると、3つのスラッシュ「///」が表示され、通常の自動コメントが表示されます。

なぜ2番目の名前が「?」になるのですか???? STRINGではないでしょうか?

0 投票する
1 に答える
7920 参照

c# - XML ドキュメントで < > 文字を含む see cref を使用しますか?

重複の可能性:
xml ドキュメントでジェネリック クラスとメソッドを参照する方法

私は see cref タグを使用しており、うまく機能しますが、see cref に string[] の一般的なリストを含める必要がありますが、ドキュメントが正しくレンダリングされません。

< と > とおそらく [] と関係があると思います

これは許可されていますか?回避策はありますか?