如何寫出易讀的程式碼？

寫程式除了自己寫出新的程式碼外，也常常需要修改其他人寫的程式碼，但見過許多許多不同的程式碼後，體會到不同人寫出的程式碼的風格差異大，質素參差，不整齊，又沒有comment。這樣的程式碼卻往往留存下來的原因就是因為大家都看不懂它到底想做甚麼，所以不敢碰它，怕一旦改了就會導致程式錯誤。。尤其是程式的作者往往已經不在了，又或者連他自己也不記得自己當時在寫甚麼。

個人認為Let code speak for themselves這一點是非常重要的，即是讓其他人單看程式碼就能看得懂，不用問作者，不用依賴其他文件。而且寫得好且漂亮的Code也能讓人讀起來沒那麼辛苦（起碼會讓人想讀），提高生產力。

以下是我自己會使用的一些原則，盡量讓自己的程式碼能讓其他人看得懂：

1. 直接了當，沒有comment也能看得懂

最好的code是用variable和function名稱本身解釋一切，你應該做的最多就是解釋「為何要這樣做」，而不是「在做甚麼」。當然把程式碼分成一段段再用comment來大致解釋那一段的用途會更好。

2. 一個屏幕顯示整個function

控制function的長度，最好在一個屏幕便能顯示function的所有（或大部分）內容
如果開始感覺function的長度超出你可以一眼理解和控制的範圍，請把部分內容拆成另外一個function，並用容易理解的命名，這樣便能讓人容易掌握這個function的input和output。

3. 用scope來限制variable的影響力

很多variable的用途是非常短暫的，可以利用scope來清楚標明variable的影響力，這樣別人便能容易理解這個variable只會在某小段區域存在，不會被後面用到。 例如下面的code，nLineLen只是用來設定szLine的，所以用完便應捨棄：

char* szLine = NULL;
{ 
    const int nLineLen = 100;
    szLine = new char[nLineLen + 1];
    memset(szLine, 0, nLineLen + 1);
}

不過要留意的是，有些語言以及比較舊的compiler會無視scope。

4. 別亂comment code

經常看見有人會把一大段code都comment掉，也許這段code只是用來debug，又或者是因為程式要求有改過所以已經不適用但又不捨得刪掉，結果讓這種commented code越來越多，影響閱讀。

如果這段code是不需要的，請無情刪了它，又或者是把舊版本放進Version Control之後再在新版本刪了它。如果因為某些原因真的不捨得移除，就起碼加上註解，解釋這段code為甚麼會被comment。

5. 幽默

如果這段程式碼不需要提交給客戶的話，便可大膽一點，comment一些有趣或者搞笑的事情，或者是用較口語化的語氣來說明一些程式碼的功用，起碼讓人看起來能夠會心一笑，不會覺得沉悶。

using namespace std

一開始學C++便看到每個程式的最頂，#include的下方都會有一句：

using namespace std;

所有C++ Standard Library中的class（例如string、map、ifstream）都屬於std這個namespace下。當你要在自己的程式內使用它們時，便需要在前方加上std::，例如std::string。但如果使用了上述那句的話，便不需要加上std::，而是讓compiler自動幫你加。

只不過這樣做的缺點就是當你自己有class和C++ Standard Library中的任何一個class撞名，compiler便可能會選錯namespace，又或者直接顯示ambigious的錯誤。解決這問題的方法主要有兩個：

1. 盡量在.cpp中加入這一句，而非.h，因為header file很容易被其他文件include，讓缺點擴散(?)
2. 指定某些class使用std namespace，而非一刀切全部用std。代碼如下：

using std::string;
using std::cout;
using std::ifstream;

Struct Member Alignment

無論用TCP還是UDP收資料都需要解碼（又叫decode或者拆packet），即是把收回來的byte array根據protocol來處理，從而抽取一些有用的資料。而我見過有些code是直接用type cast把byte array轉換成struct，然後很神奇地就會順著struct的member的順序來填入這些member variable了。

一開始我上網搜尋看到有人指出這個行為並非C++標準，而且OS可能會自行把struct的member拆開令它們在記憶體中不是連續的（例如Windows會以4個Bytes為一個DWord以提升效率），這樣的話type cast就會搞到解碼錯誤，但只要加上一些OS提供的特殊語法就沒有問題。

例如Windows的話，要在struct前後加上#pragma pack，並且在前面說明以1 Byte為pack的單位。

#pragma pack(1)
struct ABC{
/* member variables */
}
#pragma pack()

當然，我覺得始終最好的方法是在constructor寫明怎樣解碼，這樣除了比較清晰容易檢查之外，也是一個跨平台的解決方法。

參考資料：

http://blog.xuite.net/kamory0931/fightdreamer/52223417-%E7%B5%90%E6%A7%8B%E7%9A%84%E5%B0%8D%E9%BD%8A(Struct+Member+Alignment)