我用vim写Linux C代码

我用vim写Linux C代码

这些年大部分时间都在从事java开发，开发都使用eclipse，已经习惯了它的代码补全、自动缩进、代码格式化、语法检查、编码提示等多种便捷的功能，让我能够专心于实现业务代码，很大程度上保证了我的研发效率。然而我在近期的工作重点转移到了块设备研发，主要使用Linux C进行编码，于是就开始为使用何种合适的IDE犯愁了。

我不考虑使用类似VS（Visual Studio）这样的大型IDE的原因有两点：其一，我们公司的主要研发工作都在Linux（Ubuntu）操作系统上进行，能够兼容的可供选择的IDE很少；其二，学习大型IDE的成本较高（我已经在用Eclipse/Intellij，Pycharm等IDE），不大想花精力在这上面。于是我考虑其它轻量的编辑器，最终决定使用VIM进行开发（这个编辑器在大学时就已经接触了，虽然只是使用其基本功能，但已经觉得很熟悉了）。

虽然在此之前就已经能够熟练运用VIM的基本功能进行文本编辑，但是仅仅基于这些基础来进行Linux C的代码开发，还是比较牵强。下面，我将记录一些将VIM用作Linux C开发的补充工具。

补充vimrc

在逐渐完善vim过程的第一步，我从网上对比了一些现成的适合程序开发vimrc，最终采用amix维护的这个版本（搜出来的第一个——以字母a开头，维护人数很多，近期更新时间靠近当前，功能也比较齐全）。下面是链接：amix-vimrc。关于vimrc中包含的插件以及在使用时涉及的快捷方式，上面的链接都有说明，或者阅读“README.md“文件。

安装taglist插件

amix-vimrc中已经包含了很多插件，但是不包含taglist——展示和定位程序函数、结构体列表。插件地址：taglist。访问该链接并下载插件，并解压到 .vim_rumtime/my_plugins里面，于是taglist的路径为 .vim_rumtime/my_plugins/taglist。至于该插件如何使用，网上有大把的资料，这里不再累述。

使用cscope工具

cscope工具可以帮助程序开发者快速找到类型或方法实现及使用的地方，为阅读代码提供了很好的帮助。它的使用方法能够从网上查阅到大量资料，这里仅仅列出我常用的方法。

• 建立cscope索引数据库
  首先，在代码库根目录执行下面的命令找出所有的header文件和c文件，并将结果记录到“cscope.file"（这个文件名可以任意定义）：
  find . -name *.c -o -name *.h > cscope.file
  接着通过执行cscope命令就可以建立程序索引数据库了：
  cscope -Rbq -i cscope.file
  这个命令会生成以cscope作为前缀的文件，其中cscope.out就是索引数据库文件。

---

• 在vim中建立索引数据库连接
  在打开vim后，在其命令行中执行下列命令倒入当前路径下的程序索引数据库：
  :cs add cscope.out
  或者
  :cscope add cscope.out
  如果vim的当前工作路径与程序索引数据库不在同一目录下面，那么可以执行下面的命令导入索引数据库：
  :cs add

---

• 简单使用cscope
  在vim中，执行下面的命令查看类型或函数实现的地方：
  :cs find g
  在vim中执行下面的命令寻找类型或者函数使用的地方：
  :cs find c
  其它用法可以查看cscope的帮助手册：
  :cs help

使用clang-format工具

OVERVIEW: A tool to format C/C++/Java/JavaScript/Objective-C/Protobuf code.

在macbook上通过brew安装clang-format工具：
brew install clang-format
当安装clang-format成功后，我们就可以在命令行使用这个工具对文件进行格式化了。

• 命令行格式化文件
  使用clang-format内置的程序格式风格（比如LLVM）来格式化程序：
  clang-format -style=LLVM -i …
  使用自定义的程序格式风格来格式化程序：
  clang-format -style=file -i …
  自定义的文件格式记录在文件.clang-format中，该命令会自动寻找该文件，并进行格式化。有关clang-format的详细使用说明可以参考其帮助手册：
  clang-format -help
  • 有关clang-format的详细安装说明可以参考clang-format；
  • 有关clang-format自定义程序格式风格可以参考clang-format style options；
  • 有关clang-format在Linux内核编码中的使用可以参考clang-format linux kernel。

---

• vim内嵌clang-format使用
  还在摸索中……