25 文档

GNU Emacs 内置了便捷的帮助功能,其中绝大部分功能的信息都来源于与函数和变量相关联的文档字符串。本章将介绍如何在 Lisp 程序中访问这些文档字符串。

文档字符串的内容需要遵循特定的规范。具体来说,其第一行应当是一个完整的句子(或两个完整的句子),简要描述该函数或变量的功能。关于如何编写优质的文档字符串,see Tips for Documentation Strings

需要注意的是,Emacs 的文档字符串与 Emacs 手册并非同一概念。手册拥有独立的源文件,采用 Texinfo 语言编写;而文档字符串则直接定义在其所对应的函数和变量的定义体中。仅靠一组文档字符串无法构成一份完整的手册,因为优质的手册不会以这种方式组织内容,而是围绕讨论的主题来编排。

有关用于显示文档字符串的命令,可参见 Help in The GNU Emacs Manual

emacs

Emacs

org-mode

Orgmode

Donations

打赏

Copyright

© Jasper Hsu

Creative Commons

Creative Commons

Attribute

Attribute

Noncommercial

Noncommercial

Share Alike

Share Alike