2

私の同僚は、ソフトウェアで作業するときにXMLコメントを使用することはめったにありません（私がこれ以上優れているとは言えません）。私は最近それらを使用することの利点を見てきましたが、それらが文書化するコードが明確に書かれている場合（表現的/説明的な変数/関数名、いくつかのインラインコメント）、それらは本当に価値がありますか？

ありがとう！

4

6 に答える 6

5

XMLコメントは、ドキュメントの生成に役立ちます。コードが明確に記述されている場合は、コードを理解するのに役立つコメントは必要ありません。

ただし、ドキュメントのコメントは、コードの説明ではなく、クラスまたはメソッドの機能の説明を含む（すべきである）ため、クラスのユーザーにとって有用です。

于 2009-01-19T15:24:38.270 に答える
1

コードのコメントは非常に重要だと思います。特に、公開されているメソッドとプロパティではそうです。自分のコードが記述的であると言うのは、人が良いことを言っているのかもしれませんし、そうかもしれません。

Linker.Extract(IpoValidator validator, MeanDexIndicator Indicator)

メソッドのコンテキストを理解しない限り、メソッドの目的を理解できない可能性があります。人々がコメントに関して抱える主な問題は、あまり役に立たないということです。これは、人々が悪いコメントを書くためです。何が起こっているかではなく、何が起こっているかについて話すべきです。メソッドが抽出メソッドであることがわかるので、コメントは次のようになります。

 <Summary>Extracts The Fumble <\Summary>

エネルギーの無駄です。次のほうがよいです。

 <Summary>
 The Fumble needs to be extracted before the bopper can be used. In order for 
 extraction to work a validator and indicator need to be provided. Once extracted 
 the bopper is available in the property Linker.Bopper. On fail this 
 method will raise the CrappedOutException.
 </Summary>

違いを見ます？

私は要約パラメータと戻り値のみを使用する傾向があります。それらはすべてインテリセンスで表示されるためです。他のすべてはコメントのようであり、常に表示されるとは限らないため、時間の無駄になる可能性があります。

何かを変更した後、コメントの更新を拒否する人については。コードレビューはこれをキャッチする必要があります。個人的には、プライベート メソッドと小道具 2 に xml コメントを使用しますが、それは個人的な選択です。一般向けのメソッドとプロパティについて? 私はオプションではありません。

于 2011-07-01T21:28:39.117 に答える
0

XMLコメントは、少人数のグループで使用されるAPIでも非常に役立ちます。

于 2009-01-19T15:27:09.873 に答える
0

vsは、特定のコメントが存在することを自動的にチェックするため、これは便利です。また、以前にvsを使用したことのある組織に新しく参入した人は誰でも、コメントがどのように機能するかを知っているので、コメントコードの新しいシステムを説明する必要はありません。時々それからドキュメントを生成しましたが、それはあなたのために多くのもの（いくつかのパラメータタグなど）を埋めるので、実際にはそれを使用する方が簡単です

于 2009-01-19T15:27:21.073 に答える
0

機能的には無視されますが、一部のXSLTで処理して直接ドキュメントに変換できる注釈タグはありませんか？コメントは良いです（そして私はそれらを使用します）が、注釈タグの価値とそれを直接変換することは、ドキュメントとしてのコメントの使用よりも重要だと思います。したがって、要約すると、他の人が読むためのドキュメントに注釈タグを使用し、自分自身へのメモまたは「舞台裏」のものにコメントを使用します（つまり、「世界が爆発する前にこれを修正してください！」）

于 2009-01-19T16:36:34.630 に答える
0

内部向けのコードとコメントに関しては、Jeffery Palermoの投稿を読んで同意する必要があります。

要約すると、多くのコメントは可読性を低下させ、ほとんど役に立ちません。良いコメントは非常に役立ちますが、ソフトウェアを維持するためのコストが増加し、維持されずに誤った情報を提供すると大きな問題を引き起こす可能性さえあります. 適切に設計され、名前が付けられたコードに代わるものはありません。

于 2009-01-19T15:41:41.513 に答える