代碼書(shū)寫(xiě)規(guī)范說(shuō)明(編輯修改稿)
2025-05-04 12:13 本頁(yè)面
【文章內(nèi)容簡(jiǎn)介】 private const bool WEB_ENABLESSL_DEFAULT = false。注：變量名和常量名最多可以包含 255 個(gè)字符，但是，超過(guò) 25 到 30 個(gè)字符的名稱(chēng)比較笨拙。此外，要想取一個(gè)有實(shí)際意義的名稱(chēng)，清楚地表達(dá)變量或常量的用途，25 或 30 個(gè)字符應(yīng)當(dāng)足夠了。 類(lèi)（Class）命名a) 名字應(yīng)該能夠標(biāo)識(shí)事物的特性。b) 名字盡量不使用縮寫(xiě)，除非它是眾所周知的。c) 名字可以有兩個(gè)或三個(gè)單詞組成，但通常不應(yīng)多于三個(gè)。d) 在名字中，所有單詞第一個(gè)字母大寫(xiě)。例如 IsSuperUser，包含ID的，ID全部大寫(xiě)，如CustomerID。e) 使用名詞或名詞短語(yǔ)命名類(lèi)。 f) 少用縮寫(xiě)。 g) 不要使用下劃線(xiàn)字符 (_)。 例： public class FileStreampublic class Buttonpublic class String 接口（Interface）命名和類(lèi)命名規(guī)范相同，唯一區(qū)別是 接口在名字前加上“I”前綴例：interface IDBCommand。interface IButton。 方法（Method）命名和類(lèi)命名規(guī)范相同。 命名空間（NameSpace）命名和類(lèi)命名規(guī)范相同。6 編碼規(guī)則 錯(cuò)誤檢查規(guī)則a) 編程中要考慮函數(shù)的各種執(zhí)行情況，盡可能處理所有流程情況。b) 檢查所有的系統(tǒng)調(diào)用的錯(cuò)誤信息，除非要忽略錯(cuò)誤。c) 將函數(shù)分兩類(lèi)：一類(lèi)為與屏幕的顯示無(wú)關(guān)， 另一類(lèi)與屏幕的顯示有關(guān)。對(duì)于與屏幕顯示無(wú)關(guān)的函數(shù)，函數(shù)通過(guò)返回值來(lái)報(bào)告錯(cuò)誤。對(duì)于與屏幕顯示有關(guān)的函數(shù)，函數(shù)要負(fù)責(zé)向用戶(hù)發(fā)出警告，并進(jìn)行錯(cuò)誤處理。d) 錯(cuò)誤處理代碼一般放在函數(shù)末尾。e) 對(duì)于通用的錯(cuò)誤處理，可建立通用的錯(cuò)誤處理函數(shù)，處理常見(jiàn)的通用的錯(cuò)誤。 大括號(hào)規(guī)則將大括號(hào)放置在關(guān)鍵詞下方的同列處，例如：if ($condition) while ($condition){ {... ...} } 縮進(jìn)規(guī)則使用一個(gè)“Tab”為每層次縮進(jìn)。例如：function func(){if (something bad){if (another thing bad){while (more input){}}}} 小括號(hào)規(guī)則a) 不要把小括號(hào)和關(guān)鍵詞（if 、while等）緊貼在一起，要用空格隔開(kāi)它們。b) 不要把小括號(hào)和函數(shù)名緊貼在一起。c) 除非必要，不要在Return返回語(yǔ)句中使用小括號(hào)。因?yàn)殛P(guān)鍵字不是函數(shù)，如果小括號(hào)緊貼著函數(shù)名和關(guān)鍵字，二者很容易被看成是一體的。 If Then Else規(guī)則如果你有用到else if 語(yǔ)句的話(huà)，通常最好有一個(gè)else塊以用于處理未處理到的其他情況?？梢缘脑?huà)放一個(gè)記錄信息注釋在else處，即使在else沒(méi)有任何的動(dòng)作。其格式為：if (條件1) // 注釋{}else if (條件2) // 注釋{}else // 注釋{}注：if 和循環(huán)的嵌套最多允許4層 比較規(guī)則總是將恒量放在等號(hào)/不等號(hào)的左邊。一個(gè)原因是假如你在等式中漏了一個(gè)等號(hào)，語(yǔ)法檢查器會(huì)為你報(bào)錯(cuò)。第二個(gè)原因是你能立刻找到數(shù)值而不是在你的表達(dá)式的末端找到它。例如：if ( 6 == $errorNum ) ... Case規(guī)則default case總應(yīng)該存在，如果不允許到達(dá)，則應(yīng)該保證：若到達(dá)了就會(huì)觸發(fā)一個(gè)錯(cuò)誤。Case的選擇條件最好使用int或string類(lèi)型。 對(duì)齊規(guī)則變量的申明和初始化都應(yīng)對(duì)齊。例如：int m_iCount。int i,j。float m_fIne,m_fPay。m_iCount = 0。i = 1。m_fIne = 。 單語(yǔ)句規(guī)則除非這些語(yǔ)句有很密切的聯(lián)系，否則每行只寫(xiě)一個(gè)語(yǔ)句。 單一功能規(guī)則原則上，一個(gè)程序單元（函數(shù)、例程、方法）只完成一項(xiàng)功能。 簡(jiǎn)單功能規(guī)則原則上，一個(gè)程序單元的代碼應(yīng)該限制在一頁(yè)內(nèi)（25~30行）。 明確條件規(guī)則不要采用缺省值測(cè)試非零值。例如：使用“if ( 0 != f( ) )”而不用“if ( f( ) )”。 選用FALSE規(guī)則大部分函數(shù)在錯(cuò)誤時(shí)返回FALSE、0或NO之類(lèi)的值，但在正確時(shí)返回值就不定了（不能用一個(gè)固定的TRUE、1或YES來(lái)代表），因此檢測(cè)一個(gè)布爾值時(shí)應(yīng)該用 FALSE、0、NO之類(lèi)的不等式來(lái)代替。例如：使用“if ( FALSE != f( ) )” 而不用“if (TRUE == f( ) )”。 獨(dú)立賦值規(guī)則嵌入式賦值不利于理解程序，同時(shí)可能回造成
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1