文章主題:15個編程好習慣 (Al katib)
這是國外程序員Al katib總結的一些編程習慣。
1.動手編碼之前,你需要對要編碼實現的解決方案有一個正式的或粗略的設計。永遠不要在沒有任何設計的前提下就開始編碼,除非所編代碼不重要。
2.優秀的代碼文檔跟編程語言知識一樣重要。在代碼源文件中,為每個主要的代碼段添加注釋,解釋代碼的基本邏輯。最好注明程序的構建和修改日期,以及修改的原因也是非常有必要的。
3.維護程序的各個版本同樣重要。當前有些編程工具都自帶一個版本管理工具。無論你什么時候改變自己的程序,它們都會將其保存為.bak文件。
我的方法是為每個程序維護三個不同的版本。比如說,我有一個名為program.c的文件,這個文件同時也被其他項目組成員使用。我把這個文件復制為 program.c.old作為備份文件,并且當我修改時,我會備份另一個名為program.c.wrk的副本文件。當成功完成修改時替換 program.c.wrk文件。
你還可以給自己的程序版本添加一個日期或一些注釋,像program260505.c或programReadFnWrking.c。
4.如果工程包含多個源文件,則聲稱一個README文件,注明每個源文件、數據文件、臨時文件以及日志文件(如果有的話)的作用。你還可以注明編譯和運行步驟。
5.有時候,你一定想知道為什么IF語句沒有得到預想的結果。可能你使用的是等號,也就是“=”,而不是條件判定符號“==”。一個比較好的辦法是用相反的順序寫條件語句。因此,你的條件語句應該如下:
if(10==i)…因此,如果你錯誤地寫成了單個等于號,在編譯的時候也能檢查出來并報錯。
6.使用循環和條件語句時,先把左右括號對應起來,然后再在里面寫其他語句。也就是:
代碼: 1 for(int i=0;i<10;i++)2 {4 printf(“i=%dn”,i);3 } 注:每一行開頭的數字表明寫循環代碼的順序。
7.避免使用幻數(magic numbers)。例如,不要寫
代碼: circleArea = 3.14 * pow(radius,2); 而要使用如下代碼:
代碼: #define PI 3.14 circleArea = PI * pow(radius,2);
8.使用有意義的變量和函數名稱。例如,使用‘radius’來代替圓的半徑,而不是用‘r’來表示。同樣,函數名‘calculateArea’要比其他任 何隱晦的縮寫要好得多。匆忙之下,我們也許會使用縮寫的變量名,但一開始節省時間的話,之后會浪費更多的時間,去猜測縮寫變量名代表什么。(編注:)
9.為后面的調試使用打印語句,這是個好習慣。但是,當完成最后代碼后,去掉這些語句,有時也是一項危險的任務。添加一個方法,用于輸出調試信息。當最終版本生成時,只要把這個方法注釋掉就行。因此,只在一個地方做修改就可以了。
10.代碼編寫完之后,開始優化代碼。之前聲明的一些變量,現在可能沒用了。同樣,并不依賴循環的一些聲明可以移到循環模塊之外去。扎實的編譯知識同樣會對以后的代碼優化有所幫助。
11.對自己的操作系統和硬件要有足夠的了解,你可以從資源占用等方面提升程序的性能。
12. 編寫代碼時要合理使用縮進,以使代碼清晰可讀。
13.把項目文件放到SOURCE、HEADERS、MAKE、EXES等不同的文件夾中。
14.研究別人編寫的代碼。這可以讓你學習到新的編程技術,以及他們解決和你相同的任務時所使用的方法。
15.最后一條(但不是最不重要的一條),備份源代碼文件,這樣當硬盤出錯或相同的問題發生時,不至于前功盡棄。
譯文出處:伯樂在線 - 職場博客
原文作者:Al katib
|