【正文】 f it currently is not elevated./// /summary/// param name=tokenThe handle to an access token/param/// returns/// Returns true if the primary access token of the process belongs to /// user account that is a member of the local Administrators group. /// Returns false if the token does not./// /returns/// exception cref=/// When any native Windows API call fails, the function throws a /// Win32Exception with the last error code./// /exception任何調(diào)用失敗會(huì)帶來副作用的方法或函數(shù)，都需要清楚地在注釋中交代那些副作用的后果。39。 C 和 使用 .NET 描述性 XML 文檔化 注釋。C 類注釋模板:/// summary/// Class description/// /summary舉例, //// NAME: class CodeExample// DESCRIPTION: The CodeExample class represents an example of code, and // tracks the length and plexity of the example.//class CodeExample{ ...}。 您應(yīng)該為 每一個(gè)重要的類或結(jié)構(gòu)體作注釋。您應(yīng)該為那些僅通過閱讀很難理解其意圖的代碼添加注釋。amp。 // Remember this wrinkle as well }}更好的實(shí)現(xiàn)如下:Good:// Loop through each item in the wrinkles array, find the Wrinkle with // the largest impact that is new, and store it in ‘pBestWrinkle’.for （int i = 0。 // Get the next wrinkle if （pWrinkleIsNew（） amp。單行注釋應(yīng)該用于代碼的行為并不是那么明顯易懂的情況。 // The accuracy of the example}。在本例中，最好將所有變量的注釋對(duì)齊。其之前和之后都有一個(gè)空行。intialize the ponents on the Windows FormInitializeComponent（） 內(nèi)聯(lián)代碼注釋內(nèi)聯(lián)注釋應(yīng)該置于獨(dú)立行，并與所描述的代碼具有相同的縮進(jìn)。Good:// Intialize the ponents on the Windows Form.InitializeComponent（）。 // Determine whether system is running Windows Vista or later operating // systems （major version = 6） because they support linked tokens, but // previous versions （major version 6） do not.if （ = 6）{}254。一定不要 讓注釋僅僅是重復(fù)代碼。Good: // C++ / C sample:if （x 5）{ y = 0。}Bad （in AllInOne Code Framework samples）:// C++ / C sample:if （x 5） { y = 0。Allman 風(fēng)格是以Eric Allman命名的，有時(shí)也被稱為ANSI 風(fēng)格。 // No spaces after masCreateFoo（ myChar, 0, 1 ）。 // No space between function name and parenthesisMethod（myChar, 0, 1）。 空格空格通過降低代碼密度以增加可讀性 。 item）{ int counter = 0。 比如，您可以在變量聲明和代碼之間有一行空行。if （（flags amp。 您不應(yīng)該 在標(biāo)志枚舉中使用0值，除非它代表 “所有標(biāo)志被清除了” ，并被恰當(dāng)?shù)拿麨轭愃啤癗one”的名字。 位運(yùn)算屬于高級(jí)任務(wù)，所以在簡(jiǎn)單任務(wù)中無需使用它們。254。標(biāo)志枚舉通常用于表示選項(xiàng)。第二，它存在版本的問題。如果這個(gè)名稱對(duì)于特定的枚舉并不合適，可以自行定義為更準(zhǔn)確的名稱。}253。如果遵守這些規(guī)范，定義枚舉類型，而不是帶有靜態(tài)常量的結(jié)構(gòu)體，您便會(huì)得到額外的編譯器和反射支持。 一定請(qǐng) 將代表某些值集合的強(qiáng)類型參數(shù)，屬性和返回值聲明為枚舉類型。b = 2。 代碼語句253。在參數(shù)組內(nèi)，按照能夠幫助程序員輸入正確值的原則來將參數(shù)排序。函數(shù)或方法調(diào)用時(shí)的參數(shù)列表同樣需按照這一格式。例如,單行格式:// C function call sample:hr = DoSomeFunctionCall（param1, param2, param3）。 函數(shù)的聲明和調(diào)用 函數(shù)或方法的名稱，返回值，參數(shù)列表可以有多種形式。 // Pointer of the second element.Bad:CodeExample *pFirst, *pSecond。 一定不要 在同一行中聲明多個(gè)變量 。這減少了代碼的垂直空間，確保了變量不會(huì)處在未初始化的狀態(tài)。254。如果您需要修改全局變量，您應(yīng)該將其作為一個(gè)輸出參數(shù)，或返回其一份全局變量的拷貝。 一定請(qǐng) 盡量少用全局變量。 庫的使用253。為了提高易讀性，將代碼長(zhǎng)度設(shè)置為78列?？梢耘渲肰isual Studio 文字編輯器，以空格代替制表符 。 格式和風(fēng)格253。編程規(guī)范致力于確保代碼是易懂和易維護(hù)的。該規(guī)范可用于編程風(fēng)格，但不總是有益的。253。 一定不要...不允許應(yīng)用該規(guī)范或?qū)嵺`。 一定請(qǐng)...該規(guī)范或?qū)嵺`在任何情況下都應(yīng)該遵守。 術(shù)語在整個(gè)文檔中，會(huì)有一些對(duì)于標(biāo)準(zhǔn)和實(shí)踐的推薦和建議。所有的安裝和執(zhí)行過程必須可以被撤銷。4. 流行性 – 代碼示例應(yīng)當(dāng)展示現(xiàn)行的編程實(shí)踐，例如使用 Unicode，錯(cuò)誤處理，防御式編程以及可移植性。代碼必須經(jīng)過測(cè)試，且可以按照文檔描述進(jìn)行編譯和運(yùn)行。示例代碼的相關(guān)部分應(yīng)當(dāng)易于重用。本規(guī)范的目的在于幫助社區(qū)開發(fā)者提高開發(fā)效率，減少代碼中可能出現(xiàn)的bug，并增強(qiáng)代碼的可維護(hù)性。目錄1 概覽 1 原則和主旨 1 術(shù)語 22 通用編程規(guī)范 3 明確和一致 3 格式和風(fēng)格 3 庫的使用 5 全局變量 5 變量的聲明和初始化 6 函數(shù)的聲明和調(diào)用 7 語句 8 枚舉 9 空格 14 大括號(hào) 15 注釋 17 代碼塊 263 C++ 編程規(guī)范 27 編譯器選項(xiàng) 27 文件和結(jié)構(gòu) 29 命名規(guī)范 30 指針 34 常量 34 類型轉(zhuǎn)換 35 Sizeof 36 字符串 37 數(shù)組 38 宏 39 函數(shù) 40 結(jié)構(gòu)體 43 類 44 COM 50 動(dòng)態(tài)分配 51 錯(cuò)誤和異常 52 資源清理 55 控制流 584 .NET 編碼規(guī)范 61 類庫開發(fā)設(shè)計(jì)規(guī)范 61 文件和結(jié)構(gòu) 61 程序集屬性 61 命名規(guī)范 61 常量 65 字符串 65 數(shù)組和集合 67 結(jié)構(gòu)體 69 類 70 命名空間 74 錯(cuò)誤和異常 74 資源清理 77 交互操作 90Page 471 概覽 本文檔為一站式示例代碼庫項(xiàng)目組所使用的C++ 以及 .NET 編碼規(guī)范 。我期待著您的參與。 同時(shí)，如果沒有如下一站式代碼示例庫項(xiàng)目的關(guān)鍵成員的辛勤付出，本文檔必定不會(huì)具有現(xiàn)在的技術(shù)深度以及完整度，我在這里要感謝他們：Hongye Sun Jie Wang Ji Zhou Michael Sun Kira Qian Linda LiuAllen Chen YiLun Luo Steven Cheng WenJun Zhang本文檔部分章節(jié)參考自一些微軟產(chǎn)品組的編程規(guī)范。 Dan 對(duì)本文檔進(jìn)行了斟字酌句的查閱，并根據(jù)其20余年的編程經(jīng)驗(yàn)提供了大量的珍貴評(píng)論 。鳴謝本文檔的每一章節(jié)都應(yīng)該感謝Dan Ruder 微軟Principal Escalation Engineer 。他們是Vivian Luo，Allen Ding，F(xiàn)elix Wu 和 Mei Liang。如果您發(fā)現(xiàn)某些最佳實(shí)踐或者話題并沒有涵蓋在本文檔中，請(qǐng)告知我們一站式示例代碼庫項(xiàng)目組 ，以不斷充實(shí)改善本文檔。但是，我們希望您能通過onecode，或給出任何改進(jìn)建議。任何指導(dǎo)準(zhǔn)則都可能會(huì)眾口難調(diào)。它們必須能展示出重點(diǎn)所在。2. 正確性 – 示例代碼必須正確展示出其欲告知使用者的重點(diǎn)。一致性將我們一站式示例代碼庫優(yōu)良的品質(zhì)形象傳遞給使用者，展示出我們對(duì)于細(xì)節(jié)的追求。不允許展示入侵性或低質(zhì)的編程實(shí)踐，不允許永久改變機(jī)器狀態(tài)。本編程規(guī)范致力于幫助您創(chuàng)建代碼示例以使使用者能夠作為最佳實(shí)踐來效仿和學(xué)習(xí)。術(shù)語意圖理由254。253。該規(guī)范用于統(tǒng)一編程風(fēng)格，保持一致和清晰的風(fēng)格。 您可以…該標(biāo)準(zhǔn)和規(guī)范您可以按需應(yīng)用。 一定請(qǐng)確保代碼的明確性，易讀性和透明性。 一定請(qǐng)確保 一旦應(yīng)用了某編程規(guī)范，需在所有代碼中應(yīng)用，以保持一致性。所有代碼都應(yīng)該使用4個(gè)空格來表示縮進(jìn)。 過長(zhǎng)的代碼降低了代碼易讀性 。 一定請(qǐng) 在您的代碼編輯器中使用定寬字體，例如 Courier New。 全局變量254。這對(duì)于靜態(tài)變量同樣適用。一般，如果語言允許，就僅在使用前聲明它們，否則就在作用域塊的頂端聲明。 一定請(qǐng) 在語言允許的情況下，將局部變量的聲明和初始化或賦值置于同一行代碼內(nèi)。253。 // Pointer of the first element.CodeExample *pSecond = NULL。CodeExample pSecond。將返回值置于函數(shù)或方法名稱的同一行。第一個(gè)類型/參數(shù)對(duì)置于新行行首，并縮進(jìn)一個(gè)制表符寬度。 一定請(qǐng) 將參數(shù)排序，并首先將輸入?yún)?shù)分組，再將輸出參數(shù)放置最后。比如，如果一個(gè)函數(shù)帶有一個(gè)輸入類型為句柄的參數(shù)作為第一參數(shù)，那么所有相關(guān)函數(shù)都應(yīng)該將該輸入句柄作為第一參數(shù)。Good: // C sample:a = 1。 枚舉254。枚舉類型是一個(gè)具有一個(gè)靜態(tài)常量集合的結(jié)構(gòu)體。 public const int Blue = 2。 一定請(qǐng) 為簡(jiǎn)單枚舉提供一個(gè)0值枚舉量，可以考慮將之命名為 “None”。首先，它加載反射和大量類型元數(shù)據(jù)，代價(jià)極其昂貴。} 標(biāo)志枚舉 標(biāo)志枚舉用于對(duì)枚舉值進(jìn)行位運(yùn)算的支持。 一定不要 將此屬性用于簡(jiǎn)單枚舉 。 您應(yīng)該 提供一些特殊的枚舉值，以便進(jìn)行常見的標(biāo)志枚舉的組合運(yùn)算。// C sample:[Flags]public enum FileAccess{ Read = 0x1, Write = 0x2, ReadWrite = Read | Write}253。Bad: [Flags]public enum SomeFlag { ValueA = 0, // This might be confusing to users ValueB = 1, ValueC = 2, ValueBAndC = ValueB | ValueC,}SomeFlag flags = GetValue（）。省略額外的空行會(huì)加大代碼閱讀難度。 if（...） { }}Bad: // C++ sample:void ProcessItem（const Itemamp。 您應(yīng)該使用2行空行來分隔方法實(shí)現(xiàn)或類型聲明。Good: // C++ / C sample:CreateFoo（）。 // Space between function name and parenthesisMethod（myChar,0,1）。 一定請(qǐng)?jiān)谝徽臼绞纠a庫的代碼示例中使用 Allman風(fēng)格的大括號(hào)用法。Good: // C++ / C sample:if （x 5）{ y = 0。這樣做使得將來增加條件式更簡(jiǎn)便，并減少制表符引起的歧義。 您應(yīng)該 使用注釋來解釋一段代碼的設(shè)計(jì)意圖 。 即使注釋跨越多行代碼，單行注釋語法（// …）仍然是首選。 您應(yīng)該在注釋中使用首字母大寫的完整的句子，以及適當(dāng)?shù)臉?biāo)點(diǎn)符號(hào)和拼寫。39。 描述代碼塊的注釋應(yīng)該置于獨(dú)立行，與所描述的代碼具有相同的縮進(jìn)。}當(dāng)內(nèi)聯(lián)注釋只為結(jié)構(gòu)體，類成員變量，參數(shù)和短語句做描述時(shí)，則內(nèi)聯(lián)注釋允許出現(xiàn)在和實(shí)際代碼的同一行。 // The length of the example float m_accuracy。如果每一行代碼都有注釋，便會(huì)影響到可讀性和可理解性。