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) рассматриваются отдельно в описании функции. В некоторых разделах в начале описываются общие для нескольких функций особенности параметров.