Magic xpaは、プロジェクト内のオブジェクトにコメントを記入することができます。
[オプション]メニューから[コメント]をクリックするか、F12をクリックするとプロジェクト内のオブジェクトに対する[コメント]ボックスが開きます。以下のオブジェクトでコメントにアクセスすることができます。
カラム |
ヘルプ |
範囲/位置付 |
コンポーネント |
インデックス |
権利 |
埋め込みSQL |
入出力 |
データソース |
イベント |
変数項目 |
タスク |
外部キー |
モデル |
|
ロジックユニット |
プログラム |
|
コメントは、[コメント]ペインに表示されます。Alt+F12 を押下することで[コメント]ペインが開きます。
コメントには次のような特徴があります。
[コメント]ボックスには、最大1,000桁までの文字を入力することができ、サイズも変更することができます。
オブジェクトのコメントは、Magicアプリケーションのソースファイルに保存されます。コメントテキストは、キャビネットファイル(ecf)には保存されません。
各オブジェクトに、"/* ... */" という書式でコメントを定義した場合、一覧表示の[説明]欄にコメントが表示されます。また、タスクエディタ上でこのオブジェクトを使用しているカラムにカーソルが置かれた場合、下の[説明]欄にコメントが表示されます。表示するコメントの内容をMAGIC.INIで切り替えることができます。例えば以下のように定義すると、/J ~ J/ で囲まれたコメントが表示対象となります。
ShortDescriptionChar=J |
デフォルトでは、コンポーネントのコメントは公開されません。コンポーネントの[アプリケーション特性]の[コンポーネントとして使用する場合、コメントを公開]のチェックボックスをチェックすることで、公開することができます。