elisp的文档有Examples 范例吗

每次看elisp的文档或用c-h f查某个函数的文档时,总是感觉那里不对,经常要在google一下才弄清楚怎么用。对比其它语言通常看官方文档就可以了,通常都能看明白不用在去搜了。

今天对比了一下elisp和其它语言的文档,发现elisp的文档没有Examples 范例,而某些语言对某个函数文档的Examples 写得相当丰富。而 Description却写得很精简,通常就只有一行(和elisp正好反过来)。以至于我直接看Examples就可以了,Description可不用看。

elisp的文档是有意这样做的吗?还是有什么原因导致的,还是说不仅elisp,lisp系的语言都是这种风格

注:这里的某些语言可对号入座到php、go等

这个包可以在 describe-function 中添加 demo

6 个赞

M-x shortdoc 也比较实用

4 个赞

有时候确实有这个感觉。spacemacs里经常能看到的(:a 1 :b 2)的写法,当时还在学elisp语法,想知道是什么意思,但是plist里的示例我当时就没有找到

后面还是靠stackoverflow了

这个太赞了 :smiley: 对我来讲太有需要了

这个确实不错, 如果能分割成单个文件的形式, 大家可以一起贡献一下, 众人拾柴火焰高。