MATHEMATICAチュートリアル

説明文

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

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

式の途中にコメント文を入れても構わない.
In[1]:=
Click for copyable input
Out[1]=
(*text*)コメント文はプログラムコードのどこに入れてもよい

コメント文の書式

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

f::usage="text"関数の使い方メッセージを定義する
?f関数の使い方メッセージを参照する
??f関数に関してより詳細な情報を得る

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

関数を定義する.
In[2]:=
Click for copyable input
の「使い方メッセージ」を作っておく.
In[3]:=
Click for copyable input
Out[3]=
の使い方を調べてみる.
で詳細な情報を求める.の定義式自体も見られる.

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

1つの関数に関して で情報を検索するとその関数の使い方メッセージの全文が参照できる.メタキャラクタ等を使い複数の関数について情報の参照をした場合は,検索された関数名のみが,可能な場合は使用法メッセージへのリンクとともに表示される.

これは,Mathematica のシンボルの中で「Plot」で始まるものすべてである.

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

New to Mathematica? Find your learning path »
Have a question? Ask support »