by Wu Zhangjin [email protected] of TinyLab.org
2008-02-22

最初發表：泰曉科技 – 聚焦嵌入式 Linux，追本溯源，見微知著！
原文鏈接：把 VIM 打造成源代碼編輯器
評論說明：爲更好地聚合大家的討論，請到上面原文的評論區回覆。

【注】這是開源書籍《C語言編程透視》第一章，如果您喜歡該書，請關注我們的新浪微博@泰曉科技。

把VIM打造成源代碼編輯器

前言

程序開發過程中，源代碼的編輯主要是爲了實現算法，結果則是一些可閱讀的、便於檢錯的、可移植的文本文件。如何產生一份良好的源代碼文件，這不僅需要一些良好的編輯工具，還需要開發人員養成良好的編程修養。

Linux下有很多優秀的程序編輯工具，包括專業的文本編輯器和一些集成開發環境(IDE)中提供的編輯工具，前者的代表作有vim和emacs，後者的代表作則有Eclipse，Kdevelope，Anjuta等，這裏主要介紹vim的基本使用和一些基本配置。

常規操作

##通過vim進行文本編輯的一般過程包括：文件的打開、編輯、保存、關閉/退出，而編輯則包括插入新內容、替換已有內容、查找內容，還包括複製、粘貼、刪除等基本操作。

該過程如下圖：

Vim基本使用過程

下面介紹幾個主要操作：

打開文件

在命令行下輸入"vim 文件名"即可打開一個新的文件並進入vim的“編輯模式”。

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

編輯模式下，vim會把鍵盤輸入解釋成vim的編輯命令，以便實現諸如字符串查找(按下字母/)、文本複製（按下字母yy）、粘貼（按下字母pp）、刪除（按下字母d等）、替換(s)等各種操作。

當按下a/A/i/I/o/O/s/S/c/C等字符時，vim先執行這些字符對應的命令動作（比如移動光標到某個位置，刪除某些字符），然後進入插入模式；進入插入模式後可以通過按下ESC鍵或者是CTRL+C返回到編輯模式。

在編輯模式下輸入冒號:後可進入命令模式，通過它可以完成一些複雜的編輯功能，比如進行正則表達式匹配替換，執行Shell命令（按下!命令）等。

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

需要提到的是，如果在編輯模式按下字母v/V或者是CTRL+V，可以用光標選擇一個區塊，進而結合命令模式對這一個區塊進行特定的操作。

編輯文件

打開文件以後即可進入編輯模式，這時可以進行各種編輯操作，包括插入、複製、刪除、替換字符。其中兩種比較重要的模式經常被“獨立”出來，即上面提到的插入模式和命令模式。

保存文件

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

退出/關閉

保存好內容後就可退出，只需在命令模式下鍵入字符q。如果對文件內容進行了編輯，卻沒有保存，那麼vim會提示，如果不想保存之前的編輯動作，那麼可按下字符q並且在之後跟上一個感嘆號!，這樣會強制退出，不保存最近的內容變更。

命令模式

這裏需要着重提到的是vim的命令模式，它是vim擴展各種新功能的接口，用戶可以通過它啓用和撤銷某個功能，開發人員則可通過它爲用戶提供新的功能。下面主要介紹通過命令模式這個接口定製vim以便我們更好地進行源代碼的編輯。

編碼風格與indent命令

先提一下編碼風格。剛學習編程時，代碼寫得很“難看”（不方便閱讀，不方便檢錯，看不出任何邏輯結構），常常導致心情不好，而且排錯也很困難，所以逐漸意識到代碼編寫需要規範，即養成良好的編碼風格，如果換成俗話，那就是代碼的排版，讓代碼好看一些。雖說“編程的“（高雅一些則稱開發人員）不一定懂藝術，不過這個應該不是“搞藝術的”（高雅一些應該是文藝工作人員）的特權，而是我們應該具備的專業素養。在Linux下，比較流行的“行業”風格有KR的編碼風格、gnu的編碼風格、Linux內核的編碼風格（基於KR的，縮進是8個空格）等，它們都可以通過indent命令格式化，對應的選項分別是-kr，-gnu，-kr -i8。下面演示用indent命令把代碼格式化成上面的三種風格。

這樣糟糕的編碼風格看着會讓人想“哭”，太難閱讀啦：

    $ 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=%dn",i,j);
    
     return 0;
    }

格式化成kr風格，好看多了：

    $ 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=%dn", i, j);
        return 0;
    }

採用gnu風格，感覺不如kr的風格，處理if語句時增加了代碼行，卻並沒明顯改進效果：

    $ 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=%dn", i, j);
      return 0;
    }

實際上indent命令有時候會不靠譜，也不建議“先污染再治理”，而是從一開始就堅持“可持續發展”的觀念，在寫代碼時就逐步養成良好的風格。

用vim命令養成良好編碼風格

從演示中可看出編碼風格真地很重要，但是如何養成良好的編碼風格呢？經常練習，遵守某個編碼風格，一如既往。不過這還不夠，如果沒有一個好編輯器，習慣也很難養成。而vim提供了很多輔助我們養成良好編碼習慣的功能，這些都通過它的命令模式提供。現在分開介紹幾個功能；

<th align="left">
  功效
</th>

vim命令

:syntax on

<td align="left">
  語法加“靚”（亮）
</td>

:syntax off

<td align="left">
  語法不加“靚”（亮）
</td>

:set cindent

<td align="left">
  C語言自動縮進（可簡寫爲<code>set cin</code>）
</td>

:set sw=8

<td align="left">
  自動縮進寬度（需要<code>set cin</code>纔有用）
</td>

:set ts=8

<td align="left">
  設定TAB寬度
</td>

:set number

<td align="left">
  顯示行號
</td>

:set nonumber

<td align="left">
  不顯示行號
</td>

:setsm

<td align="left">
  括號自動匹配
</td>

這幾個對代碼編寫來說非常有用，可以考慮把它們全部寫到~/.vimrc文件(vim啓動時會去執行這個文件裏頭的內容)中，如；

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

相關小技巧

需要補充的幾個技巧有；

對註釋自動斷行
- 在編輯模式下，可通過gqap命令對註釋自動斷行（每行字符個數可通過命令模式下的set textwidth=個數設定）
跳到指定行
- 命令模式下輸入數字可以直接跳到指定行，也可在打開文件時用vim +數字文件名實現相同的功能。
把C語言輸出爲html
- 命令模式下的TOhtml命令可把C語言輸出爲html文件，結合syntax on，可產生比較好的web page把代碼發佈出去。
註釋掉代碼塊
- 先切換到可視模式（編輯模式下按字母v可切換過來），用光標選中一片代碼，然後通過命令模式下的命令s#^#//#g把某這片代碼註釋掉，這非常方便調試某一片代碼的功能。
切換到粘貼模式解決Insert模式自動縮進的問題
- 命令模式下的set paste可解決複製本來已有縮進的代碼的自動縮進問題，後可執行set nopaste恢復自動縮進。
使用vim最新特性
- 爲了使用最新的vim特性，可用set nocp取消與老版本的vi的兼容。
全局替換某個變量名
- 如發現變量命名不好，想在整個代碼中修改，可在命令模式下用%s#old_variable#new_variable#g全局替換。替換的時注意變量名是其他變量一部分的情況。
把縮進和TAB鍵都替換爲空格
- 可考慮設置expandtab，即set et，如果要把以前編寫的代碼中的縮進和TAB鍵都替換掉，可以用retab。
關鍵字自動補全
- 輸入一部分字符後，按下CTRL+P即可。比如先輸入prin，然後按下CTRL+P就可以補全了。
在編輯模式下查看手冊
- 可把光標定位到在某個函數，按下Shift+k就可以調出man，很有用。
刪除空行
- 在命令模式下輸入g/^$/d，前面g命令是擴展到全局，中間是匹配空行，後面d命令是執行刪除動作。用替換也可以實現，鍵入%s#^n##g，意思是把所有以換行開頭的行全部替換爲空。類似地，如果要把多個空行轉換爲一個可以輸入g/^n$/d或者%s#^n$##g。
創建與使用代碼交叉引用
- 注意利用一些有用的插件，比如ctags, cscope等，可以提高代碼閱讀、分析的效率。特別是open source的東西。
回到原位置
- 在用ctags或cscope時，當找到某個標記後，又想回到原位置，可按下CTRL+T。

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

    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

因爲s,t,c,C,f這幾個vim的默認快捷鍵用得不太多，所以就把它們給作爲快捷方式映射了，如果已經習慣它們就換別的字符吧。

更多的技巧可以看看後續資料。

後記

實際上，在源代碼編寫時還有很多需要培養的“素質”，例如源文件的開頭註釋、函數的註釋，變量的命名等。這方面建議看看參考資料裏的編程修養、內核編碼風格、網絡上流傳的《華爲編程規範》，以及《C Traps & Pitfalls》, 《C-FAQ》等。

參考資料

vim官方教程，在命令行下鍵入vimtutor即可
vim實用技術序列: 實用技巧，常用插件，定製vim
Graphical vi-vim Cheat Sheet and Tutorial
vim高級命令集錦
內核編碼風格: Document/codingstyle
vim and Linux CodingStyle
編程修養
C Traps & Pitfalls
C FAQ

［授權發表］把 VIM 打造成源代碼編輯器

把VIM打造成源代碼編輯器

前言

常規操作

打開文件

編輯文件

保存文件

退出/關閉

命令模式

編碼風格與indent命令

用vim命令養成良好編碼風格

相關小技巧

後記

參考資料

AI 畫圖真刺激，手把手教你如何用 ComfyUI 來畫出刺激的圖

公司剛入職了一名 Java 中級開發，短短 4 行代碼居然湊齊了 3 個 bug！我哭了~~

數據展示動態（跑分）顯示

公衆號5月C#/.NET熱文一覽

git 下載大陸鏡像地址

［授權發表］代碼測試、調試與優化小結

［授權發表］Shell編程範例之文件操作

［授權發表］把 VIM 打造成源代碼編輯器

［授權發表］進程和進程的基本操作

［授權發表］使用 JDB 調試 Android 應用程序

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結