プログラム コードにコメントを記入する

Visual LISP は、セミコロン(;)で始まるすべての AutoLISP 文をコメントとみなします。最後の 2 つのサンプル コードには、多くのコメントが記入されています。AutoLISP プログラム内のコメントは、作成者自身のために記入するもので、プログラムに必要なものではありません。コメント コードは、作成者自身のために身に付けなければならないプログラミング習慣の 1 つです。なぜ、コメントを記入するのでしょう?

• コメントを記入しておくと、将来、ユーザから要望された機能を追加するためにプログラムを編集するときに、コードの意味を容易に把握できます。頻繁に現れる関数のシーケンスでさえも記憶が薄れ、括弧が混乱してしまうことがよくあります。
• プログラムの更新作業を受け継いだ他の開発者に、コードを説明するために記入します。他の人が書いたコードを読むのは、非常に憂鬱な作業です。コメントがほとんど記入されていないコードの場合は、なおさらです。

Visual LISP には、コードにコメントを記入するのを支援するいくつかのユーティリティがあります。サンプルのコメントが、3 つのセミコロン(;;;)、ときには 2 つのセミコロン(;;)、またはただ 1 つのセミコロン(;) で始まっている点に注目してください。

スペースの関係で、このチュートリアルの以降のサンプル コードには、サンプル ソース ファイル内のすべてのコメントが含まれているわけではありません。役に立つコメントを広範に記入する習慣がすでに身に付いており、特に指定しなくてもコメントを自由に記入するものとします。