把 Vim 打造成源代碼編輯器

前言

程序開發(fā)過程中，源代碼的編輯主要是為了實(shí)現(xiàn)算法，結(jié)果則是一些可閱讀的、便于檢錯(cuò)的、可移植的文本文件。如何產(chǎn)生一份良好的源代碼，這不僅需要一些良好的編輯工具，還需要開發(fā)人員養(yǎng)成良好的編程修養(yǎng)。

Linux 下有很多優(yōu)秀的程序編輯工具，包括專業(yè)的文本編輯器和一些集成開發(fā)環(huán)境（IDE）提供的編輯工具，前者的代表作有 Vim 和 Emacs，后者的代表作則有 Eclipse，Kdevelope，Anjuta 等，這里主要介紹 Vim 的基本使用和配置。

常規(guī)操作

通過 Vim 進(jìn)行文本編輯的一般過程包括：文件的打開、編輯、保存、關(guān)閉/退出，而編輯則包括插入新內(nèi)容、替換已有內(nèi)容、查找內(nèi)容，還包括復(fù)制、粘貼、刪除等基本操作。

該過程如下圖：

下面介紹幾個(gè)主要操作：

打開文件

在命令行下輸入 vim 文件名 即可打開一個(gè)新文件并進(jìn)入 Vim 的“編輯模式”。

編輯模式可以切換到命令模式（按下字符 :）和插入模式（按下字母 a/A/i/I/o/O/s/S/c/C 等或者 Insert 鍵）。

編輯模式下，Vim 會(huì)把鍵盤輸入解釋成 Vim 的編輯命令，以便實(shí)現(xiàn)諸如字符串查找(按下字母 /)、文本復(fù)制（按下字母 yy）、粘貼（按下字母 pp）、刪除（按下字母 d 等）、替換（s）等各種操作。

當(dāng)按下 a/A/i/I/o/O/s/S/c/C 等字符時(shí)，Vim 先執(zhí)行這些字符對(duì)應(yīng)命令的動(dòng)作（比如移動(dòng)光標(biāo)到某個(gè)位置，刪除某些字符），然后進(jìn)入插入模式；進(jìn)入插入模式后可以通過按下 ESC 鍵或者是 CTRL+C 返回到編輯模式。

在編輯模式下輸入冒號(hào) : 后可進(jìn)入命令模式，通過它可以完成一些復(fù)雜的編輯功能，比如進(jìn)行正則表達(dá)式匹配替換，執(zhí)行 Shell 命令（按下 ! 命令）等。

實(shí)際上，無論是插入模式還是命令模式都是編輯模式的一種。而編輯模式卻并不止它們兩個(gè)，還有字符串查找、刪除、替換等。

需要提到的是，如果在編輯模式按下字母 v/V 或者是 CTRL+V，可以用光標(biāo)選擇一個(gè)區(qū)塊，進(jìn)而結(jié)合命令模式對(duì)這一個(gè)區(qū)塊進(jìn)行特定的操作。

編輯文件

打開文件以后即可進(jìn)入編輯模式，這時(shí)可以進(jìn)行各種編輯操作，包括插入、復(fù)制、刪除、替換字符。其中兩種比較重要的模式經(jīng)常被“獨(dú)立”出來，即上面提到的插入模式和命令模式。

保存文件

在退出之前需切換到命令模式，輸入命令 w 以便保存各種編輯后的內(nèi)容，如果想取消某種操作，可以用 u 命令。如果打開 Vim 編輯器時(shí)沒有設(shè)定文件名，那么在按下 w 命令時(shí)會(huì)提示沒有文件名，此時(shí)需要在 w 命令后加上需要保存的文件名。

退出/關(guān)閉

保存好內(nèi)容后就可退出，只需在命令模式下鍵入字符 q。如果對(duì)文件內(nèi)容進(jìn)行了編輯，卻沒有保存，那么 Vim 會(huì)提示，如果不想保存之前的編輯動(dòng)作，那么可按下字符 q 并且在之后跟上一個(gè)感嘆號(hào)!，這樣會(huì)強(qiáng)制退出，不保存最近的內(nèi)容變更。

命令模式

這里需要著重提到的是 Vim 的命令模式，它是 Vim 擴(kuò)展各種新功能的接口，用戶可以通過它啟用和撤銷某個(gè)功能，開發(fā)人員則可通過它為用戶提供新的功能。下面主要介紹通過命令模式這個(gè)接口定制 Vim 以便我們更好地進(jìn)行源代碼的編輯。

編碼風(fēng)格與 indent 命令

先提一下編碼風(fēng)格。剛學(xué)習(xí)編程時(shí)，代碼寫得很“難看”（不方便閱讀，不方便檢錯(cuò)，看不出任何邏輯結(jié)構(gòu)），常常導(dǎo)致心情不好，而且排錯(cuò)也很困難，所以逐漸意識(shí)到代碼編寫需要規(guī)范，即養(yǎng)成良好的編碼風(fēng)格，如果換成俗話，那就是代碼的排版，讓代碼好看一些。雖說“編程的“（高雅一些則稱開發(fā)人員）不一定懂藝術(shù)，不過這個(gè)應(yīng)該不是“搞藝術(shù)的”（高雅一些應(yīng)該是文藝工作人員）的特權(quán)，而是我們應(yīng)該具備的專業(yè)素養(yǎng)。在 Linux 下，比較流行的“行業(yè)”風(fēng)格有 KR 的編碼風(fēng)格、GNU 的編碼風(fēng)格、Linux 內(nèi)核的編碼風(fēng)格（基于 KR 的，縮進(jìn)是 8 個(gè)空格）等，它們都可以通過 indent 命令格式化，對(duì)應(yīng)的選項(xiàng)分別是-kr，-gnu，-kr -i8。下面演示用 indent 命令把代碼格式化成上面的三種風(fēng)格。

這樣糟糕的編碼風(fēng)格看著會(huì)讓人想“哭”，太難閱讀啦：

$ cat > test.c
/* test.c -- a test program for using indent */
#include<stdio.h>

int main(int argc, char *argv[])
{
 int i=0;
 if (i != 0) {i++; }
 else {i--; };
 for(i=0;i<5;i++)j++;
 printf("i=%d,j=%d\n",i,j);

 return 0;
}

格式化成 KR 風(fēng)格，好看多了：

$ indent -kr test.c
$ cat test.c
/* test.c -- a test program for using indent */
#include<stdio.h>

int main(int argc, char *argv[])
{
    int i = 0;
    if (i != 0) {
        i++;
    } else {
        i--;
    };
    for (i = 0; i < 5; i++)
        j++;
    printf("i=%d,j=%d\n", i, j);
    return 0;
}

采用 GNU 風(fēng)格，感覺不如 KR 的風(fēng)格，處理 if 語句時(shí)增加了代碼行，卻并沒明顯改進(jìn)效果：

$ indent -gnu test.c
$ cat test.c
/* test.c -- a test program for using indent */
#include<stdio.h>

int
main (int argc, char *argv[])
{
  int i = 0;
  if (i != 0)
    {
      i++;
    }
  else
    {
      i--;
    };
  for (i = 0; i < 5; i++)
    j++;
  printf ("i=%d,j=%d\n", i, j);
  return 0;
}

實(shí)際上 indent 命令有時(shí)候會(huì)不靠譜，也不建議“先污染再治理”，而是從一開始就堅(jiān)持“可持續(xù)發(fā)展”的觀念，在寫代碼時(shí)就逐步養(yǎng)成良好的風(fēng)格。

需要提到地是，Linux 的編碼風(fēng)格描述文件為內(nèi)核源碼下的 Documentation/CodingStyle，而相應(yīng)命令為 scripts/Lindent。

用 Vim 命令養(yǎng)成良好編碼風(fēng)格

從演示中可看出編碼風(fēng)格真地很重要，但是如何養(yǎng)成良好的編碼風(fēng)格呢？經(jīng)常練習(xí)，遵守某個(gè)編碼風(fēng)格，一如既往。不過這還不夠，如果沒有一個(gè)好編輯器，習(xí)慣也很難養(yǎng)成。而 Vim 提供了很多輔助我們養(yǎng)成良好編碼習(xí)慣的功能，這些都通過它的命令模式提供?，F(xiàn)在分開介紹幾個(gè)功能；

這幾個(gè)命令對(duì)代碼編寫來說非常有用，可以考慮把它們?nèi)繉懙?~/.vimrc 文件（Vim 啟動(dòng)時(shí)會(huì)去加載這個(gè)文件里頭的內(nèi)容）中，如：

$ cat ~/.vimrc
:set number
:set sw=8
:set ts=8
:set sm
:set cin
:syntax on

相關(guān)小技巧

需要補(bǔ)充的幾個(gè)技巧有；

• 對(duì)注釋自動(dòng)斷行

• 在編輯模式下，可通過 gqap 命令對(duì)注釋自動(dòng)斷行（每行字符個(gè)數(shù)可通過命令模式下的 set textwidth=個(gè)數(shù) 設(shè)定）

• 跳到指定行

• 命令模式下輸入數(shù)字可以直接跳到指定行，也可在打開文件時(shí)用vim +數(shù)字 文件名實(shí)現(xiàn)相同的功能。

• 把 C 語言輸出為 html

• 命令模式下的TOhtml命令可把 C 語言輸出為 html 文件，結(jié)合 syntax on，可產(chǎn)生比較好的網(wǎng)頁把代碼發(fā)布出去。

• 注釋掉代碼塊

• 先切換到可視模式（編輯模式下按字母 v 可切換過來），用光標(biāo)選中一片代碼，然后通過命令模式下的命令 s#^#//#g 把某這片代碼注釋掉，這非常方便調(diào)試某一片代碼的功能。

• 切換到粘貼模式解決 Insert 模式自動(dòng)縮進(jìn)的問題

• 命令模式下的 set paste 可解決復(fù)制本來已有縮進(jìn)的代碼的自動(dòng)縮進(jìn)問題，后可執(zhí)行 set nopaste 恢復(fù)自動(dòng)縮進(jìn)。

• 使用 Vim 最新特性

• 為了使用最新的 Vim 特性，可用 set nocp 取消與老版本的 Vi 的兼容。

• 全局替換某個(gè)變量名

• 如發(fā)現(xiàn)變量命名不好，想在整個(gè)代碼中修改，可在命令模式下用 %s#old_variable#new_variable#g 全局替換。替換的時(shí)注意變量名是其他變量一部分的情況。

• 把縮進(jìn)和 TAB 鍵都替換為空格

• 可考慮設(shè)置 expandtab，即 set et，如果要把以前編寫的代碼中的縮進(jìn)和 TAB 鍵都替換掉，可以用 retab。

• 關(guān)鍵字自動(dòng)補(bǔ)全

• 輸入一部分字符后，按下 CTRL+P 即可。比如先輸入 prin，然后按下 CTRL+P 就可以補(bǔ)全了。

• 在編輯模式下查看手冊(cè)

• 可把光標(biāo)定位在某個(gè)函數(shù)，按下 Shift+k 就可以調(diào)出 man，很有用。

• 刪除空行

• 在命令模式下輸入 g/^$/d，前面 g 命令是擴(kuò)展到全局，中間是匹配空行，后面 d 命令是執(zhí)行刪除動(dòng)作。用替換也可以實(shí)現(xiàn)，鍵入 %s#^\n##g，意思是把所有以換行開頭的行全部替換為空。類似地，如果要把多個(gè)空行轉(zhuǎn)換為一個(gè)可以輸入 g/^\n$/d 或者 %s#^\n$##g。

• 創(chuàng)建與使用代碼交叉引用

• 注意利用一些有用的插件，比如 ctags, cscope 等，可以提高代碼閱讀、分析的效率。特別是開放的軟件。

• 回到原位置

• 在用 ctags 或 cscope 時(shí)，當(dāng)找到某個(gè)標(biāo)記后，又想回到原位置，可按下 CTRL+T。

這里特別提到 cscope，為了加速代碼的閱讀，還可以類似上面在 ~/.vimrc 文件中通過 map 命令預(yù)定義一些快捷方式，例如：

if has("cscope")
          set csprg=/usr/bin/cscope
          set csto=0
          set cst
          set nocsverb
          " add any database in current directory
          if filereadable("cscope.out")
            cs add cscope.out
          " else add database pointed to by environment
          elseif $CSCOPE_DB != ""
            cs add $CSCOPE_DB
          endif
          set csverb
:map \ :cs find g <C-R>=expand("<cword>")<CR><CR>
:map s :cs find s <C-R>=expand("<cword>")<CR><CR>
:map t :cs find t <C-R>=expand("<cword>")<CR><CR>
:map c :cs find c <C-R>=expand("<cword>")<CR><CR>
:map C :cs find d <C-R>=expand("<cword>")<CR><CR>
:map f :cs find f <C-R>=expand("<cword>")<CR><CR>
endif

因?yàn)?s,t,c,C,f 這幾個(gè) Vim 的默認(rèn)快捷鍵用得不太多，所以就把它們給作為快捷方式映射了，如果已經(jīng)習(xí)慣它們作為其他的快捷方式就換別的字符吧。

注 上面很多技巧中用到了正則表達(dá)式，關(guān)于這部分請(qǐng)參考：正則表達(dá)式 30 分鐘入門教程。

更多的技巧可以看看后續(xù)資料。

后記

實(shí)際上，在源代碼編寫時(shí)還有很多需要培養(yǎng)的“素質(zhì)”，例如源文件的開頭注釋、函數(shù)的注釋，變量的命名等。這方面建議看看參考資料里的編程修養(yǎng)、內(nèi)核編碼風(fēng)格、網(wǎng)絡(luò)上流傳的《華為編程規(guī)范》，以及《C Traps & Pitfalls》, 《C-FAQ》等。

參考資料

• Vim 官方教程，在命令行下鍵入 vimtutor 即可

• vim 實(shí)用技術(shù)序列

• 實(shí)用技巧
• 常用插件

• 定制 Vim

• Graphical vi-vim Cheat Sheet and Tutorial
• Documentation/CodingStyle
• scripts/Lindent。
• 正則表達(dá)式 30 分鐘入門教程
• 也談 C 語言編程風(fēng)格：完成從程序員到工程師的蛻變
• Vim 高級(jí)命令集錦
• 編程修養(yǎng)
• C Traps & Pitfalls
• C FAQ