XMLコードに参照コメントを追加する

XMLコードに参照コメントを追加する方法については、このステップバイステップのチュートリアルを参照してください。 5分でこの機能を実行する方法を学ぶことができます。このプロセスは簡単ですが、始める前にXMLコメントとその有用性についての基本的な知識があります。

XMLコメントが有用な理由

XMLのコメントは、HTMLのコメントとほぼ同じです。両方の構文が同じであるためです。コメントを使用すると、何年も前に書いたコードを理解することができます。また、開発したコードをレビューしている別の開発者が、あなたが書いたことを理解するのに役立ちます。要するに、これらのコメントはコードの文脈を提供します。

コメントを付けると、簡単にメモを残したり、XMLコードの一部を一時的に削除することができます。 XMLは「自己記述型データ」として設計されていますが、XMLコメントを残す必要がある場合があります。

入門

コメントタグは、コメントを開始する部分と終了する部分の2つの部分で構成されます。開始するには、コメントタグの最初の部分を追加します

役に立つヒント

XMLコードに参照コメントを追加するときは、ドキュメントの最上部に参照コメントを付けることはできません。 XMLでは、XML宣言だけが最初に来ることができます：

上で述べたように、コメントは別のものの中に入れ子にされることはできません。最初のコメントを閉じる前に、最初のコメントを閉じる必要があります。また、コメントはタグ内では発生しません。

.

コメントの最初と最後には、2つのダッシュ（ - ）を使用しないでください。コメントの中の何かはXMLパーサーには見えませんので、残っているものはまだ有効で整形式であることに十分注意してください。

ラッピング

XMLコードに参照コメントを追加することについてまだ疑問がある場合は、書籍がどのように機能するかを詳細に把握したい場合があります。本などの書籍 Rod Stephensの "C＃5.0 Programmer's Reference"が役立つかもしれません。