問題タブ [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 投票する
2 に答える
860 参照

.net - Reflector からコードの XML コメントを表示する方法

新しいプロジェクトに移動する場合に備えて、特にソースコードを持っているにもかかわらず、リフレクターを使用してアセンブリを参照することを好みます。でもソースコードのXMLコメントがリフレクターで見れるようになればいいなと思います。

それを行うアドインはありますか?

よろしくお願いします。

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

visual-studio - Visual Studio XMLコメントをwikifyすることは可能ですか?

Visual Studioによって生成されたXMLコメントファイルから一連のWikiページを生成することは可能ですか?

私はサンドキャッスルのようなものについて話しているが、コンパイルされたCHMの代わりにウィキ形式のために。

編集:私はXMLで記事をインポート/エクスポートできるMediaWikiを使用しています。したがって、XMLコメントをMediaWikiXMLに変換する変換を記述できることを願っています。

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

c# - Resources.Designer.csのXMLコメント?

Visual Studio 2008プロジェクトには、画像と文字列を含むResources.resxを含むこのプロジェクトがあります。自分自身と他のすべての人に少なくともXMLコメントを書き込むように強制するために、プロジェクトのプロパティの[ビルド]タブでXMLコメントの生成を有効にしました。これで、ドキュメント化されていないクラス、メソッドなどがある場合、VisualStudioからいくつかの警告が表示されます。これはすばらしいことです。

ただし、自動生成されたResources.Designer.cs内のすべての画像にはXMLコメントがありません(文字列にはあります)。そのため、XMLコメントが欠落しているというコンパイラの警告がいくつか表示されますが、これを変更すると、実際には何もできなくなります。とにかくファイルはおそらく上書きされます。

どちらかをするチャンスはありますか

  • デザイナーが生成したコードのXMLコメントを無視するようにコンパイラーに指示するか、
  • Visual Studio 2008にリソースコメントを生成されたコードに書き込むように強制しますか?

ヒントをありがとう!

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

vb.net - Visual Studio 2008で[XMLドキュメントファイルの生成]をオンにせずにXMLコメントタグを自動的に作成することはできますか(VB.NETのみ)?

VS 2008で、開発者が'''を押すと、XMLコメントタグが生成されますが、これは、[XMLドキュメントファイルの生成]のプロジェクト設定がチェックされている場合にのみ機能します。

プロジェクトの設定に関係なく、VSにXMLコメントタグを生成するように指示する方法はありますか?

誰かがコメントを欲しがっていても、XMLドキュメントファイルを作成しない可能性があると思います。

この場合、私は現在のチーム設定を超えていますが、他の開発者は私がこのプロジェクト設定を変更することを望んでいません。これにより、プロジェクトをチェックインする前に、これを元に戻す必要があります。

「コード分析」のような他のプロジェクト設定でも同じ問題があります。

これは、VB.NETプロジェクトでのみ問題になります。

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

.net - .NETソースコードのXMLコメントをアセンブリメタデータに永続化するにはどうすればよいですか?

システムアセンブリの一部のメソッドについて、.NETリフレクターにもそれぞれのドキュメントが表示されていることに気づきましたか?これは、ドキュメントをアセンブリメタデータに永続化できることを意味します。

どうすれば自分のアセンブリで機能させることができますか?つまり、.NETリフレクターに反映するときに、メソッドへのコメントを確認したいと思います。

ありがとう。

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

.net - XMLソースコメントをテキストドキュメントに自動的にエクスポートするにはどうすればよいですか?

私はXMLコメントを使用して、VB.Net(およびアクセスした場合はC#)でソースコードを文書化しています。Visual Studioの外部で簡単に参照できるように、XMLコメントをテキストドキュメントまたはその他の形式に自動的にエクスポートする方法があると、昔誰かが私に言ったことを覚えているようです。ある?それは何ですか、それとも彼らですか?

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

visual-studio - Visiual Studio 2008 ですべての XML コメントを折りたたむ方法

c# の肥大化した xml コメントを取り除くためのプラグイン、アドオン、またはその他の簡単な方法があるかどうか疑問に思っていましたか?

会社はドキュメンテーションを求めていますが、私の日常業務では、コメントは単にコードを汚染しています。メソッドの前にあるすべての xml ドキュメントを単純に 1 行に折りたたむ、または何もない状態にする簡単な方法があると便利です :-)

誰でもアイデアはありますか?

ティア

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

vb.net - XML コメントIntelliSense で表示されない

VB.NET XML コメントをIntelliSenseで動作させようとしていますが、思ったように動作しない可能性があります。

これは、関数を入力しているときに、「患者コードを取得または設定する」を表示し、その下に「検証:」をヘッダーとして含む箇条書きの項目のリストを表示する必要がありますか?

代替テキスト http://www.codejames.com/errored.jpg

私のやり方が間違っているのかもしれませんが、正しく動作していないようです。

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

c# - メソッドの xml ドキュメントを自動修正する方法

以下の xml ドキュメントのコードでは、メソッドの引数のパラメーターの名前と xml ドキュメントのパラメーターの名前が一致していません。xml ドキュメントの署名を自動修正する方法、または resharper で提供されている xml ドキュメントを自動修正する機能はありますか。

たとえば、次のような xml ドキュメントを含むメソッドが必要です。

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

c# - XML コメントでサポートされている文字エンティティは何ですか?

次の例では、&Δは OK ですが、Δそうではありません (後者の 2 つは両方とも Δ です)。コンパイラは次のような警告を発行します。

XML コメントでサポートされている文字エンティティは何ですか?