何のつつじヶ崎(現在のXMLを利用したコメントです。います。

StackOverflow https://stackoverflow.com/questions/2584901

  •  24-09-2019
  •  | 
  •  

質問

私は理解できなつつじヶ崎(現在のXMLを利用したコメントです。よく知ってい変換することができ良文書は外部のコードが同じに達成できるのかに簡潔なものsyntax.私の意見はXMLコメントが間違っているためには、多くの

  1. れ蓑にコメントとのコードです。（書く人による).
  2. 以下のコードでも見ることができ単一画面で、"概要"および"/サマリー"ための日数が必要となります。
  3. (削除)

何をしながっている理由、なぜXMLした優先す。当期純ないのではなく、むしろ単純なものの構文?

役に立ちましたか？

解決

本当に芋ここに正解はありません。システムは、実際に「より良い」以外ではありませんどちらも - 彼らは両方を使用すると、コードのドキュメントを生成することを可能にしている、最終的に同じ仕事をする

。

最終的な出力は、それらのそれぞれについて、まったく同じ方法でフォーマットすることができ、それらはほとんどそれらがサポートなどをラベルかの点では同じ機能を持っているか、本当にダウンここでは個人の選択にそのようにします。

個人的に、私ははるかに論理的かつ単純に使いやすいように、より多くの人間が読めるようにXMLのコメントを見つける - しかし、それは視覚的なスタジオを持つことの付加的な利点である自動でちょうど塗りつぶし、および優れたサポートに私のスタブを生成しますそれは彼らが、画面上のスペースの多くを取りませんので、それらを崩壊するために持っています。私は、VIまたはsome_other_IDEのバックグラウンド編集から来て、誰かが異なる意見を持っていることを確信しているが、本当の利点は、どちらかにありません。

私は本当にそれはあなたが使用してどのようなあなたとあなたのチームが使用するために使用されます。

何をIDEに依存していることだと思いますので

MicrosoftはXMLが別の質問でのVisual Studio、内コメントと非常に緊密に統合することを選択した理由を今、あなたが求めている場合。おそらくそれは、その事実によるものである：彼らは（彼らはコードがなどインテリセンスコメントやビルドを読む/生成するために、既存を再利用することができたように）、彼らは基準」にこだわるのための傾向を持っているVS以内に実施することが簡単になります「とにかく（それ自身のか、業界のものも）、また、ジェフで述べたような理由のライセンスを供与ます。

ジャストは、社内のXMLドキュメント生成ツールである、MicrosoftはVSの中に使用している製品は、「サンドキャッスル」と呼ばれていることを追加します。それは持っている独自のwikiページ@ http://docproject.codeplex.com/Wikipageする

他のヒント

  1. のideで拾ったコメントを示して使います。
  2. 皆様にプログラムC#うにXMLコメントをシステム。が満を学ぶための新します。

ると言うつもりはありませんものね、それは要するに、xmlコメントをシステムでは皆様の身近なことになる。けるようにな未満のものまで電車で新規採用。

とく変uncommented.目標が達成された場合は明らかではなかったのですが、自分以外の誰か（6ヶ月以降)です。

Ok今思うだと思います。

  1. Obfuscating。の色分け役になっています。個人的に、私はすぐにスキャン過去のグレーの文字のみ読み込むかの場合を除いてを読み込む必要があり、xmlます。私の設定で少なくとも).

  2. して大型モニターしますコードの画面です。で安く購入した大型モニターによるretrain、一般の人が).その他のもこもこベットのみを積極的に見つ機能で、その全体機能に合情報画面のスクロールすだろうな苦しみも見られないよります。現場の機能、そして見られるのは、問題です。

  3. 置いています要旨のコメントは単一のラインが可能となっている。る少なくなり、使用スペース。

  4. わからない場合DOxygenは、崩壊のコメントです。

XML文書の主な仕事は、ドキュメントを生成するために、のないのです。それはあなたのクラスのクライアントのために良いのIntelliSense情報を提供することです。あなたのアセンブリと一緒に生成された.xmlファイルを出荷します。

.NET

にXMLコメントを使用しての美徳

これらはネイティブにオンライン、印刷、およびインテリセンスドキュメントで使用するためにあなたのAPIを文書化するための単一の場所を提供し、C＃コンパイラとVisual Studioでサポートされています。

次のことを述べてのMSDNの雑誌から

この記事：

  

はすべてのプロジェクトでは、誰かがそこにあります   ドキュメントに満足していないです。   チームリーダーは、よりコメントが欲しいです   ソース、テクニカルライターが欲しいです   詳細書き込まれた情報   コードのデザインは、品質保証を望んでいます   機能仕様を確認して、   上のようにします。これらのドキュメントのすべてがある場合   実際に書き込まれ、あなたはまだ持っています   それらのすべてを保つの戦い   同期ます。

フォーマットは必ずしも理想的ではありませんが、

、XMLドキュメントコメントは、これを達成することができるような豊かな構文を提供しています。

なぜC＃でDoxygenのをサポートしていない代わりに？

は、既存のXMLシステムはDoxygenの上で選ばれた理由については、私はこれは主に Doxygenの<ある疑いがあるでしょう/>の下でリリースされた GPL のVisual StudioとC＃コンパイラでしょうも必要性を意味していますMicrosoftは間違いなくGPLの条件を考慮したいと思うんではないだろうと何か - などとしてリリースされますのます。

私はもっとmindblowingは ghostdoc のプラグインの人気です見つけます。あなたは自動的にメソッド名に基づいてコメントを生成することができれば、なぜ全てのコメントがありますか？

スティーブ・イェジはのですコメント上ことを言います初心者プログラマの兆候、私は彼と一緒に不同意苦労しています。

あなたません。のHAVE のプロジェクトでそれらを使用します。

Visual Studioのに統合することが、あなたがStyleCopを使用する場合、彼らは強制することができたまたま

これはのA の標準。ここでは美徳である。

このだから あなたはDoxygenのを使用することにした場合、

しかし、その後、あなたを止めるものは何もありません。ちょうどあなたが一貫して行います。

所属していません StackOverflow
scroll top