微軟一站式示例代碼庫中文版

本文檔為一站式示例代碼庫項目組所使用的C++ 以及 .NET 編碼規(guī)范 。該規(guī)范源自于產(chǎn)品開發(fā)過程中的經(jīng)驗，并在不斷完善。如果您發(fā)現(xiàn)一些最佳實踐或者話題并沒有涵蓋在本文檔中，請聯(lián)系我們一站式示例代碼庫項目組 ，以不斷充實完善本文檔。

任何指導(dǎo)準(zhǔn)則都可能會眾口難調(diào)。本規(guī)范的目的在于幫助社區(qū)開發(fā)者提高開發(fā)效率，減少代碼中可能出現(xiàn)的bug，并增強(qiáng)代碼的可維護(hù)性。萬事開頭難，采納一個不熟悉的規(guī)范可能在初期會有一些棘手和困擾，但是這些不適應(yīng)很快便會消失，它所帶來的好處和優(yōu)勢很快便會顯現(xiàn)，特別是在當(dāng)您接手他人代碼時。
1.1 原則和主旨
高質(zhì)量的代碼示例往往具有如下特質(zhì):

1. 易懂 – 代碼示例必須易讀且簡單明確。它們必須能展示出重點(diǎn)所在。示例代碼的相關(guān)部分應(yīng)當(dāng)易于重用。示例代碼不可包含多余代碼。它們必須帶有相應(yīng)文檔說明。

2. 正確性 – 示例代碼必須正確展示出其欲告知使用者的重點(diǎn)。代碼必須經(jīng)過測試，且可以按照文檔描述進(jìn)行編譯和運(yùn)行。

3. 一致性 – 示例代碼應(yīng)該按照一致的編程風(fēng)格和設(shè)計來保證代碼易讀。 同樣的，不同代碼示例之間也應(yīng)當(dāng)保持一致的風(fēng)格和設(shè)計，使使用者能夠很輕松的結(jié)合使用它們。一致性將我們一站式示例代碼庫優(yōu)良的品質(zhì)形象傳遞給使用者，展示出我們對于細(xì)節(jié)的追求。

4. 流行性 – 代碼示例應(yīng)當(dāng)展示現(xiàn)行的編程實踐，例如使用 Unicode，錯誤處理，防御式編程以及可移植性。示例代碼應(yīng)當(dāng)使用當(dāng)前推薦的運(yùn)行時庫和API函數(shù)，以及推薦的項目和生成設(shè)置。
...

2.1 明確性和一致性
 一定請確保代碼的明確性，易讀性和透明性。編程規(guī)范致力于確保代碼是易懂和易維護(hù)的。沒有什么勝于清晰、簡潔、自描述的代碼。

 一定請確保 一旦應(yīng)用了某編程規(guī)范，需在所有代碼中應(yīng)用，以保持一致性。
2.2 格式和風(fēng)格
 一定不要使用制表符。不同的文字編輯器使用不同的空格來生成制表符 ，這就帶來了格式混亂。所有代碼都應(yīng)該使用4個空格來表示縮進(jìn)。

可以配置Visual Studio 文字編輯器，以空格代替制表符 。
 

...