Linux作業系統是一個開源的作業系統,為此你在Linux系統上開發的一個工具軟體,包括原始碼,可能其他系統管理員也需要用到。為此在編寫代碼的時候,就需要遵守一定的規則。這不僅是為了方便他人的閱讀,也是為了以後自己的維護與升級考慮。具體的來說,筆者認為Linux系統管理員要養成下面的一些好的編碼風格。
一、 合理防治函數開頭的左花括弧。
根據大部分系統管理員認可的編碼風格,往往將函數開頭的左括弧放到字碼頁的最左邊。要避免將其他的括弧(包括左花括弧、左括弧或者左方括弧)放到最左邊。這主要是為了便於閱讀。因為函數的主體內容往往是有一對花括弧括起來的。如果在字碼頁的最左邊只有代表函數的花括弧,那麼就可以一目瞭然的看到函數的主體。為此這是提高代碼閱讀性的一個很好的手段。
需要注意的是,這可能跟其他語言的編程風格有所差異。如在Java語言或者C語言平台上,往往將函數主體開頭的花括弧放在函數的後面。如在main函數後面會直接使用{這個左花括弧。不過這不利於程式的閱讀,不利於Linux系統管理員找到函數的主體代碼。為此如果有其他程式設計語言使用經驗的系統管理員,最好能夠改變這種書寫習慣。筆者建議,系統管理員還是要將這個花括弧放在最左邊,並保證在整個代碼中,最左邊出現的花括弧都是代碼函數主體的花括弧。
二、 每個函數開頭最好都有一個簡短的代表功能的說明。
在Linux的功能代碼中,其各個功能也都是一個個函數或者程式構成的。也就是說,在一個代碼檔案中,可能會有很多個函數構成。那麼這些函數主要用來實現什麼功能呢?如果不做任何說明的話,那麼只有看完函數的全部代碼之後才能夠瞭解這個資訊。這對於他人閱讀原始碼會造成比較大的障礙。而且,時間久了之後,可能連繫統管理員自己都不知道這個函數時用來實現什麼功能的。這對於其後續維護與升級顯然是不利的。為此筆者建議各位系統管理員,無論是為自己還是為他人,最好在每個函數或者程式的開頭都寫上一小段注釋。好記性不如爛筆頭,這對於提高代碼的易讀性。另外需要說明的是,由於Linux系統可能對中文的支援並不是很好,為此在寫這個注釋的時候,最好採用英文書寫。因為在一些對中文支援並不是很好的系統中,這個中文會顯示為亂碼,此時就起不到應有的作用了。如果不懂英文的話,那麼可能只有使用拼音了。當然這隻是笑話。一般Linux系統工程師對於英文需要一定的瞭解。因為Linux作業系統中的協助文檔都是英文寫的。所以這個英文的語言關也是系統管理員必須要解決的關口。
另外在對函數進行說明時,最好還需要著名這個函數需要使用者傳入什麼參數,會返回什麼樣的結果。以及參數、結果的個數等等。這對於代碼的編譯與維護非常有協助。而且項目團隊中的其他成員如果要引用你這個函數的話,那麼不需要查看函數的具體代碼。而只需要查看一些這個注釋,就可以知道需要傳遞進去哪些參數。這也是提高項目合作效率的一個手段。
三、 If語句使用要規範。
在Linux系統中編寫代碼時,IF語句是使用的最多的結構之一。這個if語句主要用來實現一些邏輯的判斷。雖然這個語句本身比較簡單,但是在使用這個語句時,最好也能夠遵守一些規則。雖然這些規則主要是從易讀性的角度去考慮的,但是對於編寫一個準確的IF結構語句也有所協助。
如根據Linux系統的編程習慣,最好不要在IF的條件中進行賦值。IF語句需要根據某個條件來進行判斷該採取什麼樣的操作。在這個條件中,根據文法是可以在這個條件中對變數進行賦值的。但是這不符合Linux系統下的編程風格。筆者建議,最好在IF結構外部對變數進行賦值,然後再在條件中直接使用這個變數。這更易於控制IF結構。另外,如果在IF語句中使用嵌套的話,可以使用花括弧將嵌套的IF ELSE語句括起來,以利於發現這個嵌套語句。在其他應用程式編寫過程中,是使用縮排的方式來凸現IF嵌套結構的。但是Linux系統管理員更加喜歡使用花括弧。雖然這兩個沒有實質上的區別,但是筆者還是建議採用花括弧。因為這是一個Linux作業系統業內普遍認可的一個編碼風格。