2.9.23 説明文

Mathematicaにはプログラムに説明を加えるための手法がいろいろ用意されている．しかし，プログラムを分かりやすくするという意味では，特別な説明を加えるより先に，使うオブジェクトに動作・作用が直ちに分かるような意味のある名前を付けるということがより重要だろう．

それでも，プログラムの機能や流れを分かりやすくするため説明を加えるとよい．これには，いわゆるコメント文を書き入れることになるが，式の記述と区別するため，説明文の文頭と末尾にカッコとアスタリスクの組合せ記号を加える．つまり， (*説明文 *)というようにする．コメント文の中に別のコメント文を入れても構わない．

式の途中にコメント文を入れても構わ ない．

In[1]:= If[a > b, (* then *) p, (* else *) q]

Out[1]=

コメント文の書式

プログラムを書く上での約束事として，関数を定義したら「使い方メッセージ」を設けておき，関数の基本機能等が参照できるようにしておく．関数に使い方メッセージを登録するには f::usageの名前に使い方を説明した文を割り付ける．メッセージを参照するには ?fと入力する．

関数の使い方メッセージの定義と参照

関数 fを定義する．

In[2]:= f[x_] := x^2

fの「使い方メッセージ」を作っておく．

In[3]:= f::usage = "f[x]はxの２乗を与えます．"

Out[3]=

使い方を調べてみる．

In[4]:= ?f

詳細な情報を求める．fの定義式自体も見られる．

In[5]:= ??f

単に fの名前で関数定義だけをしたのなら， ?fと入力すれば fの値が表示される．関数の使い方メッセージも定義してあれば， ?fと入力すると使い方メッセージだけが表示される．また， ??fと入力すれば，関数定義式を含むfに関する詳細な情報が表示される．

1つの関数に関して ?で情報を検索するとその関数の使い方メッセージの全文が参照できる．メタキャラクタ等を使い複数の関数について情報の参照をした場合は，検索された関数名のみが表示される．

説明メッセージの種類

関数のより詳しい説明のため，使い方情報の他に脚注や関連関数は何か等の情報もメッセージの形で提供できるようになっている．

テキスト型インターフェースでは，メッセージとコメント文がプログラムに関する主要な情報源になる．ノートブック型インターフェースを使っている場合は，テキストセルの形で提供されるより詳細な説明が得られる．