More than 3 years have passed since last update.

MAXScriptでコメントを書く方法

Posted at 2020-03-11

概要

コメントとは、コード内にメモ書きを行うための機能です。

付箋を貼って、後から見た人に分かりやすく説明を書いておくイメージです。

コメント内に書かれた文字は、MAXScriptの式として扱われません。

したがって、自由に文章を書く事ができます。

コメントは、ハイフン記号を2つ連続で記載（ -- ）した箇所よりも右側が、コメントとして扱われます。

a = 10 -- a に 10 を代入
print a

上のコードを実行すると、 -- a に 10 を代入 の部分は無視されて、 10 が表示されます。

コメントは、複数行をまたいで適用することも可能です。

その場合は、コメントにしたい文章を /* と */ で囲みます。

a = 10

/*
長文コメント1
長文コメント2
長文コメント3
*/

print a

コメントによって特定の行を無視させることで、開発中の動作確認にも用います。

これをコメントアウトと呼びます。

必要な機能確認が終わったらコメントアウトを外すか、不要であればそれ自体を削除しましょう。

以下の例では、 a = 100 がコメントとして無視されて、 10 が結果として返されます。

a = 10
// a = 100

print a

今は手が付けられないが、後で実装予定の機能を ToDo(次にやるべき作業) として書き残す場合もあります。

a = 10
// TODO ティーポットに毛を生やす処理を加える
print a

コメントが無くても読みやすいコードを書く事が良しとされますが、習得を進める間は、処理の一つずつにコメントを書いても良いと思います。

私自身の場合は、他人のMAXScriptを読み解く際に、そのようなコメントの付け方をやって勉強していました。