2.7.3 Comments and the Help System

Last-modified: 2025-03-20 (木) 20:10:14

2.7.3 コメントとヘルプシステム

コマンドhelp(ヘルプを取得するためのコマンドを参照)は、関数の最初のコメントブロックを見つけて、それをドキュメント文字列として返すことができます。つまり、組み込み関数のヘルプを取得するために使用されるのと同じコマンドが、適切にフォーマットされたユーザー定義関数でも使用できます。たとえば、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 f出力を生成する

usage: f (x, t)

キーボードで作成された使い捨ての Octave プログラムにコメント行を入れることは可能ですが、コメントの目的は後で自分や他の人がプログラムを理解するのを助けることなので、通常はあまり役に立ちません。

パーサーは現在、最初のヘルプ テキストのブロック コメントではなく、 help単一行コメント (単一行コメントを参照) のみを認識します。