問題タブ [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 に答える
1700 参照

c# - XMLコメント-MSDNドキュメントの「メモ」セクション-これをどのように複製しますか?

基本的に、MSDNオンラインヘルプでは、「注」セクションに遭遇することがよくありますが、同じ出力を取得する方法を一生理解することはできません。どうやら<note>タグはありません。誰かがこれを機能させる方法を知っていますか?

IDictionary(TKey、TValue) —この例では、備考セクションに移動すると、私が話していることがわかります。

Sandcastle HelpFileBuilderを使用しています。

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

c# - xml コメントで言語を指定する方法 tag

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

c# - VS2010のコメントテンプレート

適切なコメントがないAPIを継承しており、その変更に取り組んでいます。

クラスまたはアセンブリのすべてのメンバーにデフォルトのXMLコメントを追加するための何らかのメカニズムがあるかどうか誰かが知っていますか?(Webキャストでそのようなものを見たのを覚えています。彼はそれを達成するためにPowerShellスクリプトを使用した可能性があります。)

このようにして、多くの繰り返しの手順を回避し、コメントだけを書き始めるためのすべてを整えることができます。

誰かもっと良い提案がありますか?

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

.net - .Net で多言語 (人間の言語) インテリセンスを取得する方法

ライブラリ (C#、.Net) を作成していますが、それを複数の国の顧客に配布する必要があります。クラスに XML コメントを追加すると、intellisense はアセンブリからコメントを取得し、メソッド、プロパティ、引数などの適切な説明を提供します...

アセンブリのローカライズ バージョンを作成して、XML コメントがロケールの言語で表示され、ソース コードのコピーを 1 つだけ保持する方法はありますか?

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

c# - .NETでコメントを自動ラインラップする方法は?

.NETでXMLスタイルのコメントを自動ラインラップする単一のコマンドが必要です。

例:

市販のVisualStudioプラグインがこれを実行できるのであれば、購入してもかまいません。

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

python - pyparsing-xmlコメントを解析します

xmlコメントを含むファイルを解析する必要があります。///具体的には、MSコンベンションを使用したac#ファイルです。

これから私は引き抜く必要があるfoobarか、あるいは/// foobar受け入れられるでしょう。(注-xmlをすべて1行にすると、これはまだ機能しません...)

これが私が持っているものです:

および出力するには:

しかし、私は文法が複数行にわたって機能することにあまり成功していません。

(注-上記のサンプルをPython 3.2でテストしました。動作しますが、(私の問題では)値を出力しません)

ありがとう!

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

c# - cタグとcodeタグの違い

C#xmlコメントでは、以下のタグの違いは何ですか?

0 投票する
6 に答える
111738 参照

visual-studio-2010 - Visual Studio で不足している XML コメントの警告を無効にする

500 を超えるMissing XML Comment警告があるプロジェクトがあります。XML コメント機能を削除したり、空のコメント スニペットをどこにでも貼り付けたりできることはわかっていますが、このタイプのすべての警告を無効にする 1 つの変更を加えることができる一般的なソリューションを希望します。

私が今していることは

また

それが可能かどうか興味がありました。

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

documentation - サンドキャッスル/SHFB。ヘルプ ファイル ページにプラットフォーム アイコンとバージョン情報を追加する

Sandcastle Help File Builder を使用してライブラリのヘルプ ファイルを作成しています。このライブラリには、同じコード ベースから構築された 3 つのバージョン (.NET、Silverlight、および Windows Phone 7) があります。

ヘルプ ファイル ページの下部にあるメソッド名とバージョン情報の横にプラットフォーム アイコンを追加したいと考えています。以下のスクリーンショットのようなもの。このような情報をヘルプ ファイルに追加するにはどうすればよいですか?

メソッド名の横にあるプラットフォーム アイコン ここに画像の説明を入力

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

asp.net - Visual Studioの設定エディターを使用する場合、web.configでコメントが失われるのを防ぐ方法はありますか?

Visual Studio 2010の設定エディターを使用して、.NET4web.configファイルのセクションから設定を追加/編集/削除しています。

これが私が意味するビットを説明するための(かなり漠然とした)抜粋の例です:

上記の例では、コメントは、構成ファイルをオンサイトで手動で編集する人に役立ちます(たとえば、Webアプリケーションが顧客サイトにデプロイされた後)。ただし、VS設定エディタを使用すると、設定を追加/編集/削除するたびにコメントが失われます。

これまでのところ、次の回避策を考え出しました。

  1. VS設定エディターを使用しないことを選択することもできますが、それを回避するようにチームに指示する必要があります。誰かが忘れてコメントをすべて失うことが常にあります...

  2. たくさんのコメントを入れて、web.configの別のコピーを保持することができます。次に、構成ファイルのコピーを使用してアプリケーションを出荷します...(2番目のコピーを最新の状態に保つことを忘れないでください。また、切り替えることを忘れないでください。このアイデアは好きではありません。リリース時の設定ファイル...覚えておくべきことが多すぎます。多すぎるとうまくいかない可能性があります)。

  3. 開始タグの上にコメントを追加しても問題ないように思われるので、すべてのコメントを一番上に置くことができます。

私の質問は:この問題を回避するための最良の方法は何ですか?おすすめは何ですか?