メソッド内でxmlコメントを使用する方法

私はVS 2005で多くのXMLコメントを使用していますが、今は問題があります。私はIFs、WHILEs、SELECT CASEsなどについてコメントする必要がありますが、VSはそれが不可能だと私に伝え続けます。いくつかの回避策はありませんか?

それは本当に私を助けるだろう。

0

1 答え

XML comments are useful, because tools are able to read and understand them. So, for example, if you use a method in your code that has xml comments and hover over it, the IDE might tell you the

. Or you could use them to generate a documentation website.

しかし、これはインラインコメントには当てはまりません。問題のコードを実際に見ている場合にのみ便利なので、ツールがそれらを理解できるようにする必要はありません。そして私はそれを行うツールについて知らない。

しかし、XMLコメントをインラインで使用するのに正当な理由がある場合(たとえば、カスタムドキュメントツールを使用している場合など)、あなたを止めることはありません。有効なC#です。しかし、コンパイラはそのようなXMLコメントを認識しないので、生成されたXMLファイルには存在しません。

1
追加された