coding style
最近在studying跟modify我們project的code,真的覺得一個有系統的project寫出來的code會比較好看。所謂比較好看是說,比較好看懂跟了解他在幹嘛。舉個例子來說吧:
大概是這些東西,不要再像我們之前學生的時候,int i, j, k;啦。誰知道i, j, k是什麼 <囧> 有時候,自己都會忘吧 XDDDD
- 這個struct的member變數,前面就會加一個m,像是uint8 mType;
- 變數跟function的命名,都是有意義的,像是void SetText(char *Text); 或 char *GetText(void); 你就會知道他是設定文字跟抓他裡面是什麼文字,不用看code就可以大概知道。
- 常數、數字等用define宣告。像是你想shift一個數值,應該先宣告#define SHIFT_OFFSET 10,然後再把每個要shift的地方加這個define,而不是每個地方去加10,這樣會不知道這個10是什麼東東。
- 還有就是…註解,請寫註解 m(_ _)m
大概是這些東西,不要再像我們之前學生的時候,int i, j, k;啦。誰知道i, j, k是什麼 <囧> 有時候,自己都會忘吧 XDDDD
留言
前面名稱亂取,後面很難maintain
另外function前面最好都加你負責功能的名稱,以後有人call function出問題,就會直接找你,而不需浪費時間查,公式的推導一定要註解,否則你會不知道當初怎樣導出來的... 最後改完某行BUG要記得將當初的寫法mark起來,如果改完出問題才方便對照
. 改bug要思考第一個是否會影響其他人的功能,第二個是否會影響到自己其他功能,確認無誤後才verify.這是我當初寫程式的心得,參考一下吧~