代码整洁之道-10
你應該有一個良好的代碼編寫風格。代碼格式關乎溝通,而溝通使專業開發者的頭等大事,也許你會說“讓代碼跑起來”才是開發者的頭等大事,你要知道你編寫的功能很有可能在下一個版本被修改,但代碼的風格和可讀性卻會對以后可能發生的修改行為產生深遠的影響,代碼的風格和可讀性仍會影響到可維護性和擴展性。你因該選用一套管理代碼格式的規則,然后在團隊中貫徹這些規則。哪些代碼風格值得使用呢?
1、向報紙學習。好的報紙文章有以下特點,1)第一段是整個故事的大綱,隱藏了細節;2)接著讀下去細節逐漸增加;3)文章短小精悍,很少一個故事占滿一整頁。代碼也因該要有這樣的格式,源文件最頂部應該給出最高層次概念和算法,細節逐次展開,指導找到源文件中最底層的函數和細節。
2、空白行。善于使用空白行,每行展現一個表達式或一個句子,每組代碼展示一條完整的思路,這些思路用空包行隔開。在封包聲明、導入聲明、每個函數之間都應該有空行。
3、位置。你是否曾經在某個類中摸索,從一個函數跳到另一個函數,想要弄清楚這些函數如何操作、如何互相關聯、摸索某個函數或變量的繼承關系等等,最后卻被搞糊涂了。有以下幾點需要注意:1)變量聲明應盡量可能靠近其使用位置,本地變量因該在函數的頂部。循環中的控制變量應該在循環語句中聲明。2)實體變量應該在類的頂部聲明。3)相關函數。若某個函數調用了另外一個函數,就應該把他們放在一起,而且調用者應該盡可能放在被調用者上面。3概念相關。概念相關的代碼應該放在一起,概念相關的函數他們擁有共同的命名模式,執行同一基礎任務的不同變種。即使沒有互相調用也應該放在一起。
4、代碼行的寬度。一行代碼應該多寬合適?據調研大佬們一向遵循無需拖動滾動條到右邊的原則,近年來顯示器越來越寬,但是一行代碼最好
不要超過120個字符。
5、水平方向上的間隔。1)賦值操作符前后加上空格字符以達到強調的目的;2)不要在函數名和左括號之間加空格,因為函數與其參數密切相官,如果隔開就會顯得互無關系;3)不同優先級之間用空格隔開,比如return bb - 4c
總結
- 上一篇: 生活的极致一定是简与静
- 下一篇: 代码整洁之道-11