IT技术博客大学习 共学习 共进步
全部 移动开发 后端 数据库 AI 算法 安全 DevOps 前端 设计 开发者

将PHP Manual融入(g)Vim

风雪之隅 2010-08-18 09:54:30 累计浏览 3,566 次
本机暂存

首先说个题外话: Vim发布7.3了..

在翻看Vim插件的时候, 发现了一个比较有意思的应用(非插件): 把PHP的手册融如Vim中, 在Vim中, 按”K”, 就可以跳转到光标下函数的手册说明…

1. 首先, 下载特殊定制的PHP手册(包含PHP5.3的所有函数) : vim-php-manual.tar.gz

2. 把下载的文件解压缩, 放置到一个目录, 比如/tmp/phpmuanul(windows下比如:”d:/phpmanual”).

3. 配置vimrc(linux下是.vimrc,windows下是_vimrc), 把phpmanual目录添加到runtimepath(稍后解释为什么).

4. 配置vimrc, 使得keywordprg=”help”. 在我的机器上, keywordprg默认是!man, 大多数时候, 我还是希望可以直接man到linux下的标准函数库, 所以我使用(在vimrc文件中):

autocmd BufNewFile,Bufread *.ros,*.inc,*.php set keywordprg="help

或者也可以写在vim目录下的ftplugin下的php.vim(如果没有新建), 这样在ft为php的时候,这个配置脚本就会被加载.

至于说, 为什么要把phpmanual目录添加到runtimepath, 是因为:

When no argument is given to :help the file given with the 'helpfile' optionwill be opened. Otherwise the specified tag is searched for in all "doc/tags"files in the directories specified in the 'runtimepath' option

意思就是说, 在vim中, 调用help的时候, help会去所有的runtimpath下的doc目录中寻找tags文件, 来寻找要查找的帮助关键字.

在我们下载的vim-php-manual.tar.gz文件中, 就包含了doc/tags这样的文件目录结构, 所以只要把phpmanual目录加入runtimepath, 并且设置keywordprg为vim的help, 就可以实现在光标处按”K”跳转到函数手册了.

原图已失效

使用截图

最后,补充一点, 如果在使用的时候,Vim提示你:

 tags file not sorte

那你就用vim打开phpmanual/doc/tags, 然后%sort一下就可以了…

同分类推荐文章

  1. 一个冷门的速查日历方法 (2026-05-27 16:22:00)
  2. Stack Overflow: When We Stop Asking (2026-05-20 21:51:34)
  3. Use Obsidian Sync on Desktop without Installing Obsidian (2026-03-27 00:00:00)

查看更多 开发者 文章 →

建议继续学习

  1. 使用gettext来支持PHP的多语言 (累计阅读 39,189)
  2. vim几个小技巧(批量替换,列编辑) (累计阅读 37,353)
  3. WordPress插件开发 -- 在插件使用数据库存储数据 (累计阅读 29,088)
  4. 简明Vim练级攻略 (累计阅读 22,187)
  5. Paypal接口详细代码(PHP版,非API接口) (累计阅读 19,346)
  6. Vim下的代码自动补全和代码跳转阅读 (累计阅读 15,287)
  7. 我的PHP,Python和Ruby之路 (累计阅读 13,068)
  8. 为什么要用 Emacs/Vim,而不是任何其他编辑器 (累计阅读 12,965)
  9. 高效Linux用户需要了解的命令行技能 (累计阅读 12,750)
  10. include(“./file.php”)和include(“file.php”)区别 (累计阅读 12,725)