1.3.5.1 Описание примерной функции

В описании функции имя описываемой функции указывается в первую очередь. За ним в той же строке следует список параметров. Имена, используемые для параметров, также используются в теле описания.

После перечисления всех форм вызова следующая строка содержит краткое однопредложное резюме функции.

После резюме может быть документация по входам и выходам, примеры использования функции, заметки об используемом алгоритме и ссылки на связанные функции.

Вот описание воображаемой функции foo:

: foo (x)

: foo (x, y)

: foo (x, y, …)

Вычесть x из y, а затем добавить все оставшиеся аргументы к результату.

Вход x должен быть числовым скаляром, вектором или массивом.

Необязательный вход y по умолчанию равен 19, если он не предоставлен.

Пример:

foo (1, [3, 5], 3, 9)
     ⇒ [ 14, 16 ]
foo (5)
     ⇒ 14

В более общем виде,

foo (w, x, y, …)
≡
x - w + y + …

См. также: bar

Любой параметр, имя которого содержит имя типа (например, integer или matrix), ожидается, что будет иметь тот же тип. Параметры с именем object могут быть любого типа. Параметры с другими типами имен (например, new_file) обсуждаются конкретно в описании функции. В некоторых разделах в начале описываются общие свойства параметров нескольких функций.