by falcon<zhangjinw@gmail.com>
2008-02-22
程序開發過程中，源代碼的編輯主要是為了實現算法，結果則是一些可閱讀的、便于檢錯的、可移植的...文本文件。如何產生一份良好的源代碼文件，這不僅需要一些良好的編輯工具，還需要開發人員養成良好的編程修養[3][4]。
Linux下有很多優秀的程序編輯工具，包括專門的文本編輯器和一些集成開發環境(IDE)中提供的編輯工具，前者的代表作有vim和emacs，后者的代表作則有Eclipse，Kdevelope,Anjuta等，這里主要介紹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以便我們更好地進行源代碼的編輯（對于其他的內容建議看看參考資料中提到的VIM的官方教程和VIM實用技術序列，以及其他網友總結的VIM使用技巧等）。
這里先提一下編碼風格。剛學習編程時，代碼寫得很“難看”（不方便閱讀，不方便檢錯，看不出任何邏輯結構），常常導致心情不好，而且排錯也很困難，所以逐漸意識到代碼編寫需要規范，即養成良好的編碼風格，如果換成俗話，那就是代碼的排版，讓代碼好看一些。雖說“編程的“（高雅一些則稱開發人員）不一定懂藝術，不過這個應該不是“搞藝術的”（高雅一些應該是文藝工作人員）的特權，而是我們應該具備的專業素養。在Linux下，比較流行的“行業”風格有KR的編碼風格、gnu的編碼風格、linux內核的編碼風格（基于KR的，縮進是8個空格）等，它們都可以通過indent命令格式化，對應的選項分別是- kr,-gnu,-kr -i8。下面演示用indent把代碼格式化成上面的三種風格。
| Quote: |
|
$ vim test.c
$ cat 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;
}
$ 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;
}
$ indent -gnu test.c
$ cat test.c //感覺不如kr的風格，處理if語句時增加了代碼行，卻并沒明顯改進效果
/* 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;
}
|
從演示中可看出編碼風格真的很重要，但是如何養成良好的編碼風格呢？經常練習，遵守某個編碼風格，一如既往。不過這還不夠，如果沒有一個好編輯器，習慣也很難養成。而VIM提供了很多輔助我們養成良好編碼習慣的功能，這些都通過它的命令模式提供。現在分開介紹幾個功能；
語法加“靚”（亮） :sytax on
自動縮進寬度（需要set cin才有用）：set sw=8
TAB寬度：set ts=8
顯示行號；set number
括號自動匹配；set sm
C語言自動縮進：set cin
這幾個對代碼編寫來說非常有用，可以考慮把它們全部寫到~/.vimrc文件(vim啟動的時候會去執行這個文件里頭的內容)中，如；
| Quote: |
|
$ vim ~/.vimrc
$ cat ~/.vimrc
:set number
:set sw=8
:set ts=8
:set sm
:set cin
:syntax on
:set textwidth=70
:set mouse=a
:set encoding=utf-8
:set fileencoding=chinese
:set fileencodings=ucs-bom, utf-8, chinese
:set ambiwidth=double
nmap <F2> :nohlsearch <CR>
:abbr #b /***************************************************************************************
:abbr #e ***************************************************************************************/
|
需要補充的幾個技巧有；
在編輯模式下，可通過gqap命令對注釋自動斷行（每行字符個數可通過命令模式下的"set textwidth=個數"設定）
命令模式下輸入數字可以直接跳到指定行，也可在打開文件時用“vim +數字 文件名”實現相同的功能。
命令模式下的TOhtml命令可把C語言輸出為html文件，結合syntax on，可產生比較好的web page把代碼發布出去。
先切換到可視模式（編輯模式下按字母v可切換過來），用光標選中一片代碼，然后通過命令模式下的命令“s#^#//#g"把某一片代碼給注釋掉，這非常方便調試某一片代碼的功能。
命令模式下的”set paste“可解決復制本來已有縮進的代碼的自動縮進問題，后可執行”set nopaste“恢復自動縮進。
為了使用最新的vim特性，可用"set nocp"取消與老版本的vi的兼容。
如發現變量命名不好，想在整個代碼中修改，可在命令模式下用"%s#old_variable#new_variable#g"全局替換。替換的時注意變量名是其他變量一部分的情況。
如果想把縮進和TAB鍵替換成空格，可考慮設置expandtab，即“set et”，如果要把以前編寫的代碼中的縮進和TAB鍵都替換掉，可以用retab。
為實現關鍵字補全，輸入一部分字符后，按下CTRL+P即可。比如先輸入prin，然后按下CTRL+P就可以補全了。
如果想在在編輯模式下查看Linux手冊，可把光標定位到在某個函數，按下Shift+k就可以調出man，很有用。
刪除空行，在命令模式下輸入g/^$/d，前面g命令是擴展到全局，中間是匹配空行，后面d命令是執行刪除動作。用替換也可以實現，鍵入%s#^\ n##g，意思是把所有以換行開頭的行全部替換為空。類似地，如果要把多個空行轉換為一個可以輸入g/^\n$/d或者%s#^\n$##g。
注意使用一些有用的插件，比如ctags, cscope等，可以提高代碼閱讀、分析的效率。特別是open source的東西。
更多的技巧可以看看資料[2],[6],[7]。
實際上，在源代碼編寫時還有很多需要培養的“素質”，例如源文件的開頭注釋、函數的注釋，變量的命名等。這方面建議看看參考資料里的編程修養、內核編碼風格、網絡上流傳的《華為編程規范》，以及<C Traps & Pitfalls>等。
參考的資料：
[1] VIM官方教程，在命令行下鍵入vimtutor即可
[2] IBM developerworks 中國，VIM實用技術序列
實用技巧，http://www.ibm.com/developerworks/cn/linux/l-tip-vim1/
常用插件，http://www.ibm.com/developerworks/cn/linux/l-tip-vim2/
定制VIM，http://www.ibm.com/developerworks/cn/linux/l-tip-vim3/
[3] 編程修養
http://oss.lzu.edu.cn/modules/newbb/viewtopic.php?topic_id=126&forum=13
[4] 內核編碼風格
Document/codingstyle
[5] Linux C編程(主要介紹了一些簡單的技巧)
http://blog.ednchina.com/brucedeng/4695/message.aspx
[6] vim配置，配置得當可極大方便編程等工作
http://oss.lzu.edu.cn/blog/article.php?tid_1398.html
[7] VIM高級命令集錦
http://oss.lzu.edu.cn/modules/newbb/viewtopic.php?topic_id=830&forum=6
[8] C Traps & Pitfalls(英文版，不過比較簡單呢）
http://oss.lzu.edu.cn/modules/wfdownloads/singlefile.php?cid=6&lid=64