METHOD GET COMMENTS
METHOD GET COMMENTS ( path ; comments {; *} )
引数 | 型 | 説明 | |
---|---|---|---|
path | Text, Text配列 | → | メソッドパスを格納したテキストまたはテキスト配列 |
comments | Text, Text配列 | ← | メソッドのコメント |
* | 演算子 | → | 指定時 = コンポーネントで実行されたとき、コマンドをホストデータベースに適用する (コンポーネントのコンテキスト以外ではこの引数は無視されます) |
説明
METHOD GET COMMENTSコマンドはpath引数で指定したメソッドのドキュメンテーションをcomments引数に返します。
このコマンドを使用して取得することのできるドキュメンテーションは、4Dエクスプローラーのコメント欄で定義されたものです (METHOD GET CODEコマンドを使用して取得できるコード内のコメント行ではありません)。コメントはスタイル付きテキストです:
データベースのタイプによって格納されるものが異なります:
- プロジェクトデータベースではmarkdownテキスト
- バイナリーデータベースではスタイル付きテキスト
このドキュメンテーションは、トリガー、プロジェクトメソッド、フォームメソッド、データベースメソッド、クラスに対して生成することができます。
注: フォームとフォームメソッドは同じドキュメンテーションを共有します。
テキスト配列またはテキスト変数に基づく2つのシンタックスを使用できます:
var tVpath : Text // テキスト変数
var tVcomments : Text
METHOD GET COMMENTS(tVpath;tVcomments) // 1つのメソッドのドキュメンテーション
ARRAY TEXT(arrPaths;0) // テキスト配列
ARRAY TEXT(arrComments;0)
METHOD GET COMMENTS(arrPaths;arrComments) // 複数メソッドのドキュメンテーション
2つのシンタックスを混合して使用することはできません。
コマンドがコンポーネントから実行されると、デフォルトではコンポーネントメソッドに適用されます。* 引数を渡すとホストデータベースのメソッドに適用します。
参照
プロパティ
コマンド番号 | 1189 |
スレッドセーフである | ✗ |