Vimscript 文档

in .pn).It also...确保对*围起的内容创建了正确的tags，这样你的目录的链接才能正常工作。继续并为目录中每一部分创建段头。例子我可以讲述所有的帮助文件语法和怎样使用它们，但我不喜欢这样。 所以，不如我给你一系列不同类型的Vim插件文档作为例子。对于每个例子，复制文档源代码到一个Vim缓冲区并设置它的filetype为help来观察它的渲染。 如果你想比较每个渲染效果，切回text看看。你也许需要使用你的Vimscript技能为当前缓冲区创建一个切换于help和text的映射。Clam，我自己用来写shell命令的插件。这是一个很小的范例，满足了我前面讲过的大多数内容。NERD tree，Scrooloose写的一个文件浏览插件。 注意大体结构，还有他如何在详尽解释每一项之前，总结出一个易读的列表。Surround，Tim Pope写的一个处理环绕字符的插件。 注意到它没有目录，以及不同的段头风格和表格列项(table column headers)。 弄懂他是怎么做到的，并想想你是否喜欢这种风格。这是个人风格问题啦。Splice，我自己用来解决版本控制中three-way merge conflict的插件。 注意映射列表的排版方式，以及我怎样使用ASCII流派的图片来解释布局。有时候，一图胜千言。不要忘了，Vim本身的文档也可以作为一个例子。这会给你许多可供学习的内容。写！既然你已经看过其他插件如何规划和撰写它们的文档，给你的Potion插件填补上文档内容吧。如果你不熟悉技术文档的写作，这可能会是个挑战。 学习如何去写并不容易，但一如其他技能，它需要的是更多的练习，所以现在开始吧！ 你不必苛求完美，从战争中学习战争即可。不要惧于写你没有完全弄懂的事情，待会丢掉它重写即可。 经常只要在缓冲区中信手留下几笔，将会带动你的头脑进入写作状态。 任何时候你想重起炉灶，旧版本一直会在版本控制中等你。一个开始的好方法是想象你身边也有一个使用Vim的好基友。 他对你的插件很感兴趣却未曾用过，而你的目标是让他熟练掌握。 在你写下插件工作的方式之前，考虑如何向人类进行介绍，可以让你脚踏实地，避免太深入于技术层面。如果你依旧卡住了，感觉自己无力应对写一个完整插件的文档的挑战，尝试做点简单的。 在你的~/.vimrc中找一个映射并给它写下完整的文档。解释它是干什么的，怎么用它，它怎么工作。 比如，这是我的~/.vimrc的一个例子：" "Uppercase word" mapping."" This mapping allows you to press <c-u> in insert mode to convert the" current word to uppercase. It's handy when you're writing names of" constants and don't want to use Capslock."" To use it you type the name of the constant in lowercase. While" your cursor is at the end of the word, press <c-u> to uppercase it," and then continue happily on your way:"" cursor" v" max_connections_allowed|" <c-u>" MAX_CONNECTIONS_ALLOWED|" ^" cursor"" It works by exiting out of insert mode, recording the current cursor" location in the z mark, using gUiw to uppercase inside the current" word, moving back to the z mark, and entering insert mode again."" Note that this will overwrite the contents of the z mark. I never" use it, but if you do you'll probably want to use another mark.inoremap <C-u> <esc>mzgUiw`za它比一个完整插件的文档短很多，却是一个练习写作的好练习。 如果你把~/.vimrc放到Bitbucket或GitHub，别人也更容易理解。练习给Potion插件每一部分写下文档。阅读:help help-writing来帮助你写帮助文档。阅读:help :left,?:help :right,和:help :center来学习三个有用的命令使得你的ASCII艺术字更好看。