ヘルプの形式

プログラミングのルールが分かってきたら、自分で調べられるようになるのが上級者への近道です。


HSPには“マニュアル”と“ヘルプ”が付属されています。

マニュアルはスタートメニュのショートカットから、【マニュアルインデックス】で閲覧できます。
また、“プログラムガイド”だけなら、HSPエディタの【ヘルプ】⇒【HSPプログラムガイドを開く】からでもOKです。

一方ヘルプは、【ヘルプ】⇒【HSPキーワード検索】か、キーボードの【 F1 】を押すことにより、開くことができます。
特に、調べたいキーワードを入力して【 F1 】を押すと、そのキーワードのヘルプを閲覧することができます。


その他にも、他のユーザさんが作った拡張機能を使う場合にも、必ずヘルプが付属されているはずです。

これらのような場合、自分で調べて使うことが必然となります。
ここでは、ヘルプの形式について説明していきます。

ヘルプの書式は、本書で使っているものですが、どのヘルプも同じような感じです。

[種類] 説明

 名前 p1, p2, ...

p1 : 第一引数の説明【 ?〜? (??) 】
p2 : 第ニ引数の説明【 ?〜? (??) 】
    ・
    ・

詳細

サンプルスクリプト・サンプルイメージ


何度かこのような解説をしたので、少しは見慣れているかと思います。
(既に、分かる人も居るかもしれません)

復習の意味も込めて、それぞれを見てみることにします。


『種類』とは、それがどんな機能かを表します。
(例えば、 color 命令は、画面制御命令です)

『説明』とは、具体的にどんな機能かを表します。
(例えば、 color 命令は、“色を設定する”となります)

『名前』とは、その名前を表します。
(例えば、 color 命令は、 color となります)

『p1, p2, ... 』では、引数の数を表します。
(例えば、 color 命令は3つの引数を持つので、p1, p2, p3 となります)

その下に続くのは、それぞれの値の説明になります。

【 】内は引数についての補足です。
ここで、?〜? は、引数の 最小値〜最大値 を意味し、(??)は引数のデフォルト値を意味します。


(例えば、 color 命令の場合、
   p1 : R(赤)の輝度 【 0〜255 (0) 】
   p2 : G(緑)の輝度 【 0〜255 (0) 】
   p3 : B(青)の輝度 【 0〜255 (0) 】
 となります)

 その下の『詳細』は、機能についての説明や、制限、注意、引数についての説明などです。

 また、本書ではサンプルスクリプトと、その実行結果のサンプル画像を用意しています。


名前・引数・説明は最低限必要なので、どんなに情報が少ないヘルプでも記載されているはずです。
分からなくなったり忘れてしまったら、すぐにヘルプを見る癖を身につけてください。

 




// Copyright (C) 2001-2007 NegativeCelcius. All Rights Reserved. //