關(guān)于 Dart 編碼風(fēng)格指南

Dart 編碼風(fēng)格指南

本指南由 Bob Nystrom 與 2011 年八月編寫（2015 年二月更新）

當(dāng)我們構(gòu)建好了 Dart 編碼系統(tǒng)時(shí)，使用一致的編碼風(fēng)格是很重要的。本教程是精心編寫的 Dart 風(fēng)格指南，旨在幫助大家了解該語言獨(dú)有的特性，并且讓 Dart 開發(fā)者之間的協(xié)作更加容易。

也許在本教程中有些內(nèi)容您并不認(rèn)同。即使作為作者，也有一些事情是我所不認(rèn)同的。所以，我希望各位讀者能夠先認(rèn)同一點(diǎn)，那就是通常情況下，一致性遠(yuǎn)比個(gè)人喜好要有價(jià)值的多。

對(duì)于很多東西，比如 Dart 來說，教程并不是死板的，這一點(diǎn)一定要牢記在心。隨著語言的發(fā)展，我們將會(huì)從中吸取許多經(jīng)驗(yàn)，而我們的編碼風(fēng)格也將隨之變化。這也就是必然會(huì)出現(xiàn)沒有遵循最新風(fēng)格的代碼，也可能是由于指南中存在二義性的部分或者沒有涉及的地方而使得讀者按照自己的喜好編寫了代碼。這些疏漏之處還請(qǐng)讀者們和我們一起承擔(dān)，當(dāng) Dart 及其庫(kù)逐漸穩(wěn)定的時(shí)候我們的指南也會(huì)變得更好。

你也可以看一下相關(guān)文檔：

• API Naming Guide
• Guidelines for Doc Comments

如何閱讀本指南

本指南按照從宏觀到微觀的順序大致分為了幾個(gè)部分。每個(gè)部分又包含一系列的指導(dǎo)準(zhǔn)則。每個(gè)準(zhǔn)則都包括下面這些詞：

• 做 - 該準(zhǔn)則形容了應(yīng)始終遵循的做法。你幾乎找不到理由不去遵循這些做法。
• 不要做 - 這些準(zhǔn)則則是相反的：該部分說明的內(nèi)容往往不是個(gè)好的選擇?？赐瓯局改希銓?huì)注意到這塊有不少的內(nèi)容。其他語言中的這類準(zhǔn)則有助于避免因時(shí)間推移而出現(xiàn)的錯(cuò)誤。Dart 語言是全新的一門語言，使用 Dart 時(shí)我們可以直接修復(fù)這些陷阱而不需要總是小心翼翼的。
• 最好 - 這些是你應(yīng)該遵循的做法。但是在某些情況下采取其他做法將會(huì)更好。你只需要理解這些暗示就好，當(dāng)你實(shí)際動(dòng)手時(shí)，應(yīng)該忽略這些準(zhǔn)則。
• 避免 - 這是和“最好”相對(duì)的：一般情況下你不應(yīng)該做的事，但是在很少的情況下它又是一種很好的選擇。
• 考慮 - 這些可能是你不希望遵循的，對(duì)于這些準(zhǔn)則，你可以考慮一下具體情況、一些先例甚至是你個(gè)人的喜好再?zèng)Q定要不要遵循。

看完上面這些以后，你可能感覺如果沒有一定的準(zhǔn)備就會(huì)被編碼風(fēng)格打敗。不用擔(dān)心，本指南中的大多數(shù)準(zhǔn)則都是常識(shí)，而我們都是明智的人。我們最終的目標(biāo)，就是寫出優(yōu)美的、高可讀性、高維護(hù)性的代碼。