Documentation — Elisp

Документация

В GNU Emacs есть удобные встроенные средства справки, большая часть сведений для которых берётся из строк документации, связанных с функциями и переменными. В этой главе описывается, как обращаться к строкам документации в программах на Lisp.

Содержимое строки документации должно соответствовать определённым соглашениям. В частности, первая строка должна быть законченным предложением (или двумя законченными предложениями), кратко описывающим, что делает функция или переменная. О том, как писать хорошие строки документации, см. Советы по написанию строк документации.

Обратите внимание, что строки документации Emacs — это не то же самое, что руководство Emacs. У руководств есть собственные исходные файлы, написанные на языке Texinfo; строки документации задаются в определениях соответствующих функций и переменных. Сборника строк документации недостаточно, чтобы заменить руководство, поскольку хорошее руководство устроено иначе: оно организовано по темам обсуждения.

О командах для отображения строк документации см. раздел Справка в Руководстве GNU Emacs.