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

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

© 1996–2022 The Octave Project Developers
Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions.
https://docs.octave.org/v5.2.0/A-Sample-Function-Description.html