【文章內(nèi)容簡介】 注釋與它注釋的語句間不空行，但與其他的語句間空一行。 空格 在以下情況中要使用到空格 關鍵字和左括符 “ (” 應該用空格隔開。如 while (true) C編程規(guī)范 注意 在方法名和 左括符 “ (” 之間不要使用空格，這樣有助于辨認 代碼 中的 方法調(diào)用 與 關鍵字。 多個參數(shù)用逗號隔開，每個逗號后都應加一個空格。 除了 . 之外，所有的二元操作符都應用空格與它們的操作數(shù)隔開。一元操作符、 ++及 與操作數(shù)間不需要空格。 如 a += c + d。 a = (a + b) / (c * d)。 while (d++ = s++) { n++。 } PrintSize(“size is “ + size + “ \n”)。 語句中的表達式之間用空格隔開。如 for (expr1。 expr2。 expr3) 括號 () 左括號 “ (” 不要緊靠關鍵字 ， 中間用一個空格隔開。 左括號“ (” 與方法名之間不要添加任何空格。 沒有必要的話不要在返回語句中使用 ()。 如 if (condition) (1) return 1 花括號 {} 左花括號 “ {” 放于關鍵字或方法名的下一行并與之對齊。 如 if (condition) { } public int Add(int x, int y) { } 左花括號 “ {” 要與相應的右花括號 “ }”對齊。 通常情況下左花括號 “ {”單獨成行，不與任何語句并列一行。 C編程規(guī)范 if、 while、 do 語句后一定要使用 {}，即使 {}號中為空或只有一條語句。如 if (somevalue == 1) { somevalue = 2。 } 右花括號 “ }” 后建議加一個注釋以便于方便的找到與之相應的 {。 如 while (1) { if (valid) { } // if valid else { } // not valid } // end forever C編程規(guī)范 第三章 程序注釋 注釋概述 修改代碼時，總是使代碼周圍的注釋保持最新 。 在每個例程的開始，提供標準的注釋樣本以指示例程的用途、假設和限制很有幫助。注釋樣本應該是解釋它為什么存在和可以做什么的簡短介紹 . 避免在代碼行的末尾添加注釋；行尾注釋使代碼更難閱讀。不過在批注變量聲 明時，行尾注釋是合適的；在這種情況下，將所有行尾注釋在公共制表位處對齊。 4 、 避免雜亂的注釋，如一整行星號。 而是應該使用空白將注釋同代碼分開。 5 、 避免在塊注 釋的周圍加上印刷框。 這樣看起來可能很漂亮，但是難于維護。 6 、 在部署 發(fā)布 之前，移除所有臨時或無關的注釋，以避免在日后的維護工作中產(chǎn)生混亂。 7 、 如果需要用注釋來解釋復雜的代碼節(jié)，請檢查此代碼以確定是否應該重寫它。 盡一切可能不注釋難以理解的代碼，而應該重寫它 。盡管一般不應該為了使代碼更簡單以便于人們使用而犧牲性能，但必須保持性能和可維護性之間的平衡。 8 、 在編寫注釋時使用完整的句子。 注釋應該闡明代碼，而不應該增加多義性。 9 、 在編寫代碼時就注釋，因為以后很可能沒有時間這樣做。 另外，如果有機會復查已編 寫的代碼，在今天看來很明顯的東西六周以后或許就不明顯了。 10 、 避免多余的或不適當?shù)淖⑨?，如幽默的不主要的備注? 1 使用注釋來解釋代碼的意圖。 它們不應作為代碼的聯(lián)機翻譯。 1 注釋代碼中不十分明顯的任何內(nèi)容。 13 、 為了防止問題反復出現(xiàn)，對錯誤修復和解決方法代碼總是使用注釋，尤其是在團隊環(huán)境中。 14 、 對由循環(huán)和邏輯分支組成的代碼使用注釋。 這些是幫助源代碼讀者的主要方面。 15 、 在整個應用程序中，使用具有一致的標點和結構的統(tǒng)一樣式來構造注釋。 16 、 用空白將注釋同注釋分隔符分開。 在 沒有顏色提示的情況下查看注釋時，這樣做會使注釋很明顯且容易被找到。 17 、在所有的代碼修改處加上 修改標識 的注釋。 18 、為了是層次清晰，在閉合的右花括號后注釋該閉合所對應的起點。 namespace { } // namespace 文檔型注釋 該類注釋采用 .Net 已定義好的 Xml標簽來標記，在聲明接口、類、方法、屬性、字段都應該使用該類注釋 ，以便代碼完成后直接生成代碼文檔，讓別人更好的了解代碼的實現(xiàn)和接口。 如 ///summaryMyMethod is a method in the MyClass class. ///paraHere39。s how you could make a second paragraph in a description. ///see cref=/ ///for information about output statements. ////para ///seealso cref=/ ////summary public static void MyMethod(int Int1) C編程規(guī)范 { } 類 c 注釋 該類注釋用于 1 不再使用的代碼。 2 臨時測試屏蔽某些代碼。 用法 /* [修改標識 ] [修改原因 ] . . . (the source code ) */ 單行注釋 該類注釋用于 1 方法內(nèi)的代碼注釋。如變量的聲明、代碼或代碼段的解釋。注釋示例： // // 注釋語句 // private int number。 或 // 注釋語句 private int number。 2 方法內(nèi)變量的聲明或花括號后的注釋 , 注釋示例 ： if ( 1 == 1) // always true { statement。 } // always true 注釋標簽 標簽 用法 作用 c ctext/c 為您提供了一種將說明中的文本標記為代碼的方法。使用 code 將多行指示為代 C編程規(guī)范 text 希望將其指示為代碼的文本。 碼 para paracontent/para content段落文本。 用于諸如 remarks 或 returns 等標記內(nèi)，使您得以將結構添加到文本中。 param param name=39。name39。description/param name 為 方法參數(shù)名。將此名稱用單引號括起來 (39。 39。)。 應當用于方法聲明的注釋中，以描述方法的一個參數(shù)。 paramref paramref name=name/ name 要引用的參數(shù)名。將此名稱用雙引號括起來 ( )。 paramref 標記為您提供了一種指示詞為參數(shù)的方法。可以處理 XML 文件，從而用某種獨特的方法格式化該參數(shù)。 see see cref=member/ cref = member 對可以通過當前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引號 ( ) 中。 使您得以從文本內(nèi)指定鏈接。使用 seealso 指示希望在 “ 請參閱 ” 一節(jié)中出現(xiàn)的文本。 seealso seealso cref=member/ cref = member 對可以通過當前編譯環(huán)境進行調(diào)用的成員或字段的引用。編譯器檢查到給定代碼元素存在后，將 member 傳遞給輸出 XML 中的元素名。必須將 member 括在雙引號 ( ) 中 使您得以指定希望在 “ 請參閱 ” 一節(jié)中出現(xiàn)的文本。使用 see 從文本 example exampledescription/example description 代碼示例的說明。 使 用 example 標記可以指定使用方法或其他庫成員的示例。一般情況下，這將涉及到 code 標記的使用。 code codecontent/code content 為希望將其標記為代碼的文本。 記為您提供了一種將多行指示為代碼的方法。使用 c 指示應將說明中的文本標記為代 碼 summary summarydescription/summary 此處 description 為 對象的摘要。 應當用于描述類型成員。 使用 remarks 以提供有關類型本身的信息。 exception exception cref=memberdescription/exception cref = member 對可從當前編譯環(huán)境中獲取的異常的引用。編譯器檢查到給定異常存在后，將 member 轉(zhuǎn)換為輸出 XML 中的規(guī)范化元素名。 必須將 member 括在雙引號 ( exception 標記使您可以指定類能夠引發(fā)的異常。 C編程規(guī)范 ) 中。 description 說明。 include include file=39。filename39。 path=39。tagpath[@name=id]39。 / filename 包含文檔的文件名。該文件名可用路徑加以限定。將 filename 括在單引號中 (39。 39。)。 Tagpath： filename 中指向標記名的標記路徑。將此路徑括在單引號中 (39。 39。)。 name 注釋前邊的標記中的名稱說明符；名稱具有一個 id。 id 位于注釋之前的標記的 id。將此 id 括在雙引號中 ( )。 include 標記使您得以引用描述源代碼中類型和成員的另一文件中的注釋。這是除了將文