Emacs 折腾日记(二十四)——帮助信息的一些优化

Emacs 是一个自文档的系统，任何有关Emacs的信息都可以通过Emacs自身查阅。包括基础的入门手册、elisp手册、以及各种插件的相关说明信息。

一般遇到不懂的变量直接使用 C-h v。查看它的说明。使用 C-h f 查阅相关函数、使用 C-h k 来查找对应快捷键绑定的函数。

一般来说阅读官方一手的文档比从任何论坛或者搜索引擎来的更快更准确，而且有不少Emacs高手都推荐多多阅读Emacs的官方文档。本节就着重介绍一下我了解的关于阅读文档的一些姿势。

查找相关定义

最开始介绍过使用 C-h f 之类的查看相关文档，Emacs所谓的子文档不光指的是查看文档，而且还可以查看相关的源代码。有些我们可以通过文档中给出的源码链接点进去看，但是还是不如直接查看源码。

直接查看源码可以使用 find-function、find-variable、find-function-on-key。它们分别对应着查找函数、变量、以及快捷键绑定的函数定义。我们可以绑定一些快捷键

(global-set-key (kbd "C-h C-f") 'find-function)
(global-set-key (kbd "C-h C-v") 'find-variable)
(global-set-key (kbd "C-h C-k") 'find-function-on-key)

对默认文档显示的优化

我觉得官方的文档显得比较素，比较原始。为了提高阅读的体验我们可以对文档进行美化。这里可以使用 helpful来增强一下。

(use-package helpful:ensure t:bind(("C-h f" . helpful-callable)("C-h v" . helpful-variable)("C-h k" . helpful-key)("C-h s" . helpful-symbol)))

我们针对 C-h k 这个快捷键来对比一下原始的文档和 helpful 增强之后的文档显示效果

对比发现，helpful 不光对显示效果进行了一些改进，而且显示的内容更加丰富。特别是它已经可以直接显示出相关定义的源代码，在某种程度上替换默认的 find-function 等函数。

which-key

在介绍配置 neovim 的时候，介绍了 which-key 插件，它可以根据用户输入的快捷键前缀显示所有可能的匹配，使我们记忆快捷键的负担减轻。Emacs上也有类似的插件。在Emacs 30以后内置了 which-key 插件，我们只需要启用

(use-package which-key:ensure t :hook (after-init . which-key-mode):custom(which-key-idle-delay 0.7))