◆ RGSS のコメント表記
2010-06-22
コメントといえば、次のような２種類があると思いますが、特別な意味を含ませる書き方があります。
# １行コメント
=begin
複数行コメント
=end
=begin
複数行コメント
=end
といっても、Ruby が解釈するのではなく、
私たちが見てわかりやすいようにするものです。
もちろん、Ruby に解釈させるものもありますが、
ツクールでは使わないでしょうから割愛させていただきます。
実行結果
インスタンスメソッド
例えば、Bitmap#draw_text などですね。
クラスメソッド
Bitmap.new
Font.default_name
Sound.play_buzzer
などなど。
クラス定数
Window_Base::WLH とか。
グローバル定数
どこからでも参照できるわけですね。
だから何なのかといいますと、こういう表記方法を知っていれば、
ドキュメントなんか書くのに余計な説明がいらないわけです。
グローバル定数にわざわざどこからでも参照できると書く必要もありませんし、
アクターの名前を調べるのスクリプトを載せるのに
$data_actors[1].name
$game_actors[1].name
$game_party.members[0].name
引数なんかで与えられることもあるので、
actor.name
などきりがないですけど、
Game_Actor#name (※ 実際は RPG::Actor#name かもだけど、細かいことは気にしない。)
と書ければ、Game_Actor オブジェクトの name メソッドで取得できるんだな。
ってわかるわけです。
xxx # => 実行結果
と書けば、左のスクリプトを実行すると右のような結果が出るという意味です。インスタンスメソッド
Object#method
クラス名#メソッド名とすると、そのクラスのインスタンスメソッドであることを表します。例えば、Bitmap#draw_text などですね。
クラスメソッド
Class.method
クラス名.メソッド名とすると、そのクラスの特異メソッドであることを表します。Bitmap.new
Font.default_name
Sound.play_buzzer
などなど。
クラス定数
Class::CONST
クラス名::CONSTとすると、そのクラスの定数であることを表します。Window_Base::WLH とか。
グローバル定数
::CONST
クラス名を書かなければ、トップレベルの定数であることを表します。どこからでも参照できるわけですね。
だから何なのかといいますと、こういう表記方法を知っていれば、
ドキュメントなんか書くのに余計な説明がいらないわけです。
グローバル定数にわざわざどこからでも参照できると書く必要もありませんし、
アクターの名前を調べるのスクリプトを載せるのに
$data_actors[1].name
$game_actors[1].name
$game_party.members[0].name
引数なんかで与えられることもあるので、
actor.name
などきりがないですけど、
Game_Actor#name (※ 実際は RPG::Actor#name かもだけど、細かいことは気にしない。)
と書ければ、Game_Actor オブジェクトの name メソッドで取得できるんだな。
ってわかるわけです。