XML コメント リテラル (Visual Basic)
XComment オブジェクトを表すリテラルです。
<!-- content -->
指定項目
語句 |
定義 |
<!-- |
必ず指定します。 XML コメントの開始を示します。 |
content |
必ず指定します。 XML コメント内の表示テキスト。 2 つの連続するハイフン (--) は使用できません。また、終了タグの直前にはハイフンを指定できません。 |
--> |
必ず指定します。 XML コメントの終了を示します。 |
戻り値
XComment オブジェクト。
解説
XML コメント リテラルには、ドキュメントの内容は記述しません。ドキュメントに関する情報を記述します。 XML コメント セクションは、"-->" で終了します。 これには以下のような条件があります。
埋め込み式の区切り記号は XML コメントの有効な内容なので、XML コメント リテラルの中で埋め込み式を使用することはできません。
XML コメント セクションは、入れ子にできません。これは、content に値 "-->" を格納できないためです。
XML コメント リテラルは、変数に代入できます。または XML 要素リテラルに含めることができます。
注意
XML リテラルは、行継続文字なしで複数の行に記述できます。この機能により、XML ドキュメントで内容をコピーし、Visual Basic プログラムに直接貼り付けることができます。
Visual Basic コンパイラは、XML コメント リテラルを#ctor コンストラクターの呼び出しに変換します。
使用例
"This is a comment" というテキストを含む XML コメントを作成する例を次に示します。
Dim com As XComment = <!-- This is a comment -->