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

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

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

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

Для команд отображения строк документации см. Помощь в Руководстве по GNU Emacs.