2.7 Octaveプログラム内のコメント

コメントは，人間が読むためにプログラムに含められ，ふつうはプログラム の一部ではないテキストのことです。コメントは，そのプログラムが行うことと， それがどのような動作をするか説明することができます。ほぼ全てのプログラミン グ言語は，コメント機能を提供しています。なぜならば，プログラムはコメントな しで理解することは概して困難であるためです。

Octave言語において，コメントはシャープ記号`#'，あるいはパーセント記号 `%'のいずれかで始まり，行末まで続きます。Octaveインタプリタは，シャー プまたはパーセント記号以降の行の内容を無視します。たとえば，関数fに 以下のようなコメントをおくことができます。

function xdot = f (x, t)

# usage: f (x, t)
#
# This function defines the right hand
# side functions for a set of nonlinear
# differential equations.

  r = 0.25;
  …
endfunction

helpコマンド（see section ヘルプを得るためのコマンド）は，関数のコメントの最初のブロッ ク（コマンドラインから直接入力された関数についても）を見つけることができま す。これは，Octaveのユーザが，組み込み関数と自分で定義した関数のヘルプを得 るためには，同じコマンドを使用できることを意味します。たとえば，上のように 関数fを定義した後，help fというコマンドを実行すると，以下の出 力が得られます。

 usage: f (x, t)

 This function defines the right hand
 side functions for a set of nonlinear
 differential equations.

キーボードから入力した一時的なOctaveプログラムにコメント行を含めることは 可能ですが，ふつうはあまり役に立ちません。なぜならば，コメントの目的は， 後から，そのプログラムを入力者または別の人に理解してもらう手助けをする ことだからです。

This document was generated on July, 20 2006 using texi2html 1.76.