關于軟件工程的幾個細節

2019-11-17 03:52:52

字體：大中小

來源：轉載

供稿：網友

軟件工程說的是用工程學的觀點開發軟件，工程學就是調配人手去實施大型作業的學問。

因此，軟件工程的重點在于人。如果說程序是算法加數據結構，那么軟件開發，除了程序這個結果，還要照顧參與開發的人員溝通等問題。就如做房子本來就是水泥和磚頭，但是進入到工程領域，就免不了多了很多輔助的工具，比如設計圖紙，工程進度之類的，這些東西雖然不構成房子，但是卻能用來統籌勞動力。

我們設計軟件，也要用到工程學的觀點。不能說有些東西不能影響程序的生成，就認為無關要緊。

其中，代碼注釋就是軟件工程的一個我們很熟悉的工具。

有些人說代碼最好不要注釋，越少越好。這并不正確。人類語言和計算機語言是有差別的，因此我們才需要用人類的語言來注釋相關的計算機代碼。注釋起碼有個好處，就算他是完全重復程序代碼本身，也能讓人迅速的了解程序的意義。你可以覺得注釋很“廢”，對編寫者來說是負擔，但是至少從閱讀者角度并不會造成什么麻煩。

為了減少對編寫者的負擔，可以將可有可無的注釋給省略。那么這個問題的答案歸根結底就是一個注釋重要性分類的學問。

以函數注釋為例：

1.注釋應該說明該函數的作用

2.對參數進行描述，包括提及參數范圍，有什么特別值之類的

3.使用代碼示例，有些函數比較特別，需要幾個函數按照一定的順序執行，這個如果不加以說明，別人很難知道

總的來說，注釋就是盡量讓別人可以方便的閱讀到相關的信息，并能作出決策。

1.公共函數的注釋要比私有函數的注釋要重要，因為讀者群更廣，你總不能要求每個用到你這個公共函數的人，都閱讀相關的代碼細節吧。如果是私有函數，閱讀的人可能就是需要修改你這個函數的人，所以他可能真的需要閱讀相關的細節，所以相對而言，注釋的重要性要低一些。同理，任何越公共的代碼，越多人使用的代碼，注釋就越重要。

2.注釋不需要重復函數實現細節。如果真的要了解細節的，還是讓他看代碼更好，如果不需要看細節的人，你告訴他細節也是沒有意義。但有一個例外，那就是如果這個函數用的是一個很復雜的算法，應該用注釋描述一下這個算法。因為算法很多時候都是比較數學化，尤其轉化為代碼的狀態，不是那么直觀的看出那段代碼到底是做了什么，有注釋效果會非常明顯。總結，注釋應該是將復雜的東西明了化的工具，而不是簡單的重復。

3.閱讀代碼最郁悶的事情，那就是被代碼牽著鼻子要圈子，從這個函數跳到那個函數，轉了一圈回來你還不知道他干了什么。注釋就在這個時候產生作用，盡量避免讀者不斷的嵌入更大的細節中，讓讀者從一個比較一致的邏輯層面建立一個宏觀的認識。當有函數調用的時候，而這個調用意義不是那么明確的時候，最好注釋一下。

反對注釋的人，很多都是基于信賴代碼自解釋的能力。有時候確實可以將注釋直接利用標識符來替代。變量的意義，函數的意義，參數的意義，都可以用標識符來做說明。標識符很好很強大（如果能用中文就更好），但是也僅僅限于這些場合而已，而注釋卻可以用在代碼的任何地方。

上一篇：個泛型的小例子 Linq查詢解決Combox綁定問題

下一篇：EyesBaby功能實現之窗口漸現效果