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 распознаёт для начального текста справки только однострочные комментарии (см. Однострочные комментарии), но не блочные комментарии.