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)

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

Хотя можно размещать комментарии в программах Octave, написанных с клавиатуры и предназначенных для одноразового использования, обычно это не очень полезно, поскольку цель комментария — помочь вам или другому человеку понять программу в будущем.

Парсер help в настоящее время распознает только однострочные комментарии (см. Однострочные комментарии), а не блочные комментарии для начального текста справки.