マニュアル表記の意味
マニュアルでは、プログラムの説明のために色や記号を使っています。それそれの意味は、次のようになります。
例文のプログラム
プロデルのプログラムは、青い四角で囲まれます。
例文のプログラム ーーこの部分は、プログラムの説明です。プログラムの動きには関係ありません。 // と表記する場合もあります
※結果 実行時の出力結果を表します。※は特殊な処理や指定を示す記号です。
種類の説明にあるバッチの意味
| 生成可能 | 「作る」文を使って、生成することで利用できる種類です。 |
| ウィンドウ部品 | ウィンドウ上に貼り付けられる部品を表す種類です。 |
| 単一種類 | 「作る」文で生成する必要なく、そのまま使える種類です。 |
| 抽象種類 | 生成することはできない種類です。定義されている手順と設定項目は、直接使えず、この種類を継承した種類を作ることで使えます。 |
| 広域種類 | 種類名を指定することなく利用できる単一種類です。 |
| 序数詞設定 | ~番目といった序数詞による設定項目を持つかどうか |
| 保護あり | 保護機能が有効な種類または手順です。 実行可能ファイルでは、実行が制限されます。 |
| 値型 | 値型の種類です。 |
| 型変換 | 型変換できる種類です。 |
| 名詞手順 | 名前が名詞である手順(名詞手順)です。送り仮名を付けたり活用したりできません。一般に実補語が ~の となる手順で定義されます。 |
| スミレ | スミレ畑で利用できる機能です。 |
プログラム文の構文や手順の書式
プログラムの構文や書式は、オレンジ色の四角で囲まれたプログラムで説明しています。プログラム中に書かれた読点(“、”や“,”)は、省略できます。また読点をスペースに変えることもできます。
【メッセージ】を表示する
書式の意味
| 【 】 | 手順の実行に必要な情報(引数)を、書く箇所であることを表します。 プログラムとして書く際には、この箇所を式(文字列や数値、変数など)に置き換えて書きます。ここでの記号“【”と“】”は書く必要がありません。 |
|---|---|
| 【 : 】 | 引数が特定の種類であることを表します。 |
| →【 】 | 引数が参照渡しされることを表します。指定した変数は手順を呼び出すことで値が変わることがあります。 |
| 【自分】 | 手順を持つ種類(レシーバオブジェクト)を書く箇所であることを表します。プログラムとして書く際には、この箇所に変数名などを書きます。 |
| 〈 〉 | 省略可能である箇所を表します。この記号で囲まれた部分は、プログラムへ書かなくてもエラーとなりません。必要な場合にだけ書いてください。 |
| {A・B} | A・Bのいずれかから選択して書く部分であることを表します。 |
設定項目の記号の意味
設定項目の一覧で使用する記号は、次のような意味を表します。
| ◎ | 設定項目の値を取得と設定が可能。 |
|---|---|
| ○ | 設定項目へ値を設定のみ可能。 |
| □ | 設定項目の値を取得のみ可能。 |
説明でよく使う表現
マニュアルの説明では、次のような表現を使います。その説明で特に明示していない限り、次のような意味を含みます。
| 番号 | 1から数えた整数の値 |
|---|---|
| ○番目 | 最初の要素を1番目として数えた時の要素の位置を示す整数の値 |
| 文字数 | 最初の文字を1文字目として数えた時の文字の個数を示す整数の値 |
| ○文字目 | 最初の文字を1文字目として数えた時の文字の位置の整数の値 |
| 連番 | 0から数えた整数の値 |
| 一覧 | 複数の要素や項目を保持した配列 |
| 内容 | 要素や項目を表現する文字列 |
| 対象 | 操作する要素や項目を示すオブジェクト |
| 戻り値 | 手順を実行した結果や、設定項目から取得した値(返り値とも) |
| 返す | 手順の実行した結果や、設定項目から取得した値を出すこと |