GNU Emacs имеет удобные встроенные средства справки, большая часть которых получает информацию из строковых описаний (documentation strings), ассоциированных с функциями и переменными. В этой главе описывается, как получить доступ к строковым описаниям в программах на Lisp.
Содержимое строкового описания должно следовать определенным конвенциям. В частности, первая строка должна быть полным предложением (или двумя полными предложениями), которое кратко описывает, что делает функция или переменная. См. Советы по строковым описаниям, как писать хорошие строковые описания.
Обратите внимание, что строковые описания для Emacs не являются тем же самым, что и руководство Emacs. Руководства имеют свои исходные файлы, написанные на языке Texinfo; строковые описания указываются в определениях функций и переменных, к которым они применяются. Коллекция строковых описаний недостаточна в качестве руководства, потому что хорошее руководство не организовано таким образом; оно организовано по темам обсуждения.
Чтобы узнать о командах для отображения строковых описаний, см. Справка в Руководстве GNU Emacs.