軟體的修改

by thinker

關鍵字:

身為 software programmer ，應該很少遇到寫一次就直接驗收的專案吧! 通常會有一些修修改改，以應付客戶的需求不明確或更動。在增、減、修改功能時，修改處往往不止一處。為了避免有任何遺漏，理想中必需要有一份修改列表，列出所有相關的項目、程式碼，逐項完成，避免遺漏，並增加工作效率。現實中，這個列表很難在執行前就完整。通常在執行修改中，會發現其它相關的程式碼需要修改。一邊記錄下這些$想法$，是很重要的事。

然而，在 $coding$ 的過程，另開一份文件記錄這些$想法$，不但會使 programmer 分心，也會有文件和程式不一致的可能性。當 programmer 換到另一份文件時，從原本的情境換到另一份文件的情境，思緒立即跟著轉疑。由於文件和程式碼是分離的， programmer 往往會延或忘記更新文件，而導至不一致。

有一個簡單的方法，可幫助 programmer 記錄 $coding$ 過程的發想；將$想法$直接寫在註解裡。註解直接依附在程式碼，能避免前述的問題。而 $coding$ 時發想的內容，往往和你正在處理的程式碼有關。因此，將兩者放在一起是很合理，而且有效的方式。然而，註解分散在許多檔案裡，要瀏覽、查詢不如單一檔案容易。為避免到處翻找記憶中的註解，建議在發想的內容前加上特別的記號，例如 `TODO:' 或 `IDEA:'，更簡單的是 `XXX:'。如此只要使用 `grep' 指令，就能輕鬆的將所有的發想都列出來，以方便瀏覽。

例如，之前我寫了一段程式碼，突然想到未來應該為兩個 table 建立關聯，於是我先將之記錄下來。如下:
{{{#!python
# TODO: make a relationship between MainIPTbl and HistIPTbl.         
cmd = 'select MainID from MainIPTbl where IPAddress = ?'
self._cur.execute(cmd, (host['host'],))
row = self._cur.fetchone()
}}}
未來，我只需使用 `grep' 指令
{{{
grep -r 'TODO:' my_src_dir/
}}}
就能列出所有的 $todo$ 內容。

這是一個簡單的方法，或許你正在使用，或許你還沒試過。希望對你能有些幫助。

最後更新時間: 2008-03-12 23:08:55 CST | 引用

查詢:

COMMENTS:

on 2008-03-12 16:18:34 CST

av said ..

打錯字囉! 思絮立即跟著轉疑 -> 思緒立即跟著轉移。

on 2008-03-12 23:09:28 CST

Thinker said ..

修正了

on 2008-03-14 19:41:16 CST

xtime said ..

Eclipse 有個 TagSEA plugin, 可以把程式中的tag用視覺化方式呈現出來。

on 2008-03-15 18:46:09 CST

bFish said ..

嗯...我也都是這樣做, 不過怎麼感覺最常出現的是 FIXME: ....哈 XD

on 2008-03-17 15:21:12 CST

Lu, Jye said ..

使用 VIM 時, 這些 tag 會有特別的效果喔, 可以試試 :)

on 2008-03-17 22:40:21 CST

Thinker said ..

xtime 是我同學嗎? 如果是，請寄封email 給我吧!!