XMLドキュメント用コメントの書き方 - VBDOX日本語化 Wiki - VBDOX日本語化

Up: 使い方

Prev: Java Styleドキュメント用コメントの書き方

Next: 一口メモ一覧

XMLドキュメント用コメントの書き方

　XMLレポートマネージャでドキュメントを生成する予定である場合に、このコメント形式でコメントを書いてください。コメントの中でコメントの構造を自由に定義できます。これで、生成されたXMLからXSLT変換できます。

　「<comment>」タグとコメントシンボル(「'」)は示されている通りである必要があります。スペースはなくてもかまいません。

例

'<comment>
' <summary>テストクラスモジュール</summary>
' <author>ms</author>
' <version>1.0.0</version>
'</comment>

もしくは

'<comment>
' <summary>ユーザに対する国名略号を設定します。</summary>
' <param name="ud">
' ユーザへの参照を指定します。</param>
' <param name="intNewValue">
' 新しい国の電話コードを指定します。</param>
' <return>
' ユーザの設定前の国名略号</return>
'</comment>

Public Function countryCode(ud As Variant, ByVal intNewValue As Integer) As Integer

注意：もし、コメント内にHTML形式のコメントを書きたい場合は、実体参照(<, >, &, " と ' )を使う必要があります。

このドキュメントはVODOXのサイト(英)を元に作成しました

Up: 使い方

Prev: Java Styleドキュメント用コメントの書き方

Next: 一口メモ一覧