每个程序都拥有自己的生命,每个程序都应该拥有自己的帮助文档。一个好的帮助文档可以让一个程序的寿命延长。当然,有了一个好的帮助文档还不够,还需要友好快捷的帮助方式。
Shell
我们在shell下可以使用各种小工具,像ls,ps,grep等,当我们需要查看ls的帮助,可以是键入man ls,至于什么是man,我们可以输入man man,就可以看到man的帮助了。
这给用户提供了一种统一而便捷的帮助接口。
Vim
Vim的帮助主要是通过:help, 例如,可以输入:help x,查看x按键的帮助。如果不指定主题,:help默认打开一个总揽的帮助窗口。
Python
Python交互式解释器除了python自带的,还有一个非常好用的交互环境是iPython,ipython - Tools for Interactive Computing in Python。
Python的文档是和对象绑定在一起的,每个对象都有一个__doc__的属性,我们可以通过这个属性查看这个对象的文档,例如print str.doc,当然,如果我们需要更详细的帮助文档,我们可以help(str),查看str的帮助。如果我们想了解一下os模块,我们可以键入help(os),就可以看到关于os的详细的帮助文档。
Python是个神奇的语言,交互解释器也是一个神奇的环境。
Emacs
emacs里面有非常详细的各种文档,我们可以是用 Ctrl+h i g 打开它,然后阅读帮助文档。
例如,我们想知道emacs的调试工具的使用,我们可以键入 Ctrl+h i g (emacs) Debuggers RET ,然后就可以看到像gdb,pdb的帮助手册。这个是非常方面的。
如果我们想知道某个按键具体是做什么的,我们可以 Ctrl+h k ,然后按下按键,例如 Ctrl+x Ctrl+f ,就会打开如下的帮助: