代碼書寫規(guī)范

???????? 格式化使代碼的邏輯結(jié)構(gòu)很明顯。花時(shí)間確保源代碼以一致的邏輯方式進(jìn)行格式化，這對于您和你的開發(fā)小組，以及以后維護(hù)源代碼的其他開發(fā)人員都有很大的幫助。

以下幾點(diǎn)是推薦的格式化方法。

• 建立標(biāo)準(zhǔn)的縮進(jìn)大小（如四個(gè)空格），并一致地使用此標(biāo)準(zhǔn)。用規(guī)定的縮進(jìn)對齊代碼節(jié)。
• 在發(fā)布源代碼的硬拷貝版本時(shí)使用特定的字體以及字號（新宋體、小五號）。
• 在括號對對齊的位置垂直對齊左括號和右括號，如：

????? for (i = 0; i < 100; i++)

????? {

?? ??????? ;??????????????

????? }

也可以使用傾斜樣式，即左括號出現(xiàn)在行尾，右括號出現(xiàn)在行首，如：

????? for (i = 0; i < 100; i++){

;

?? }

無論選擇哪種樣式，請?jiān)谡麄€(gè)源代碼中使用那個(gè)樣式。

• 沿邏輯結(jié)構(gòu)行縮進(jìn)代碼。沒有縮進(jìn)，代碼將變得難以理解，如：

????????????? if(expression )

????????????? {

???? ????????????? //

?????????????????? //此處填寫你的代碼塊;

?????????????????? //

????????????? }

?

???????? ???? if(expression )

????????????? {

?????????????????? //

?????????????????? //此處填寫你的代碼塊;

?????????????????? //

????????????? }

????????????? else

????????????? {

?????????????????? //

?????????????????? //此處填寫你的代碼塊;

?????????????????? //

????????????? }

縮進(jìn)代碼會產(chǎn)生出更容易閱讀的代碼，如：

if(expression )

???? ??{

????????????? if(expression )

????????????? {

?????????????????? //

?????????????????? //此處填寫你的代碼塊;

?????????????????? //

????????????? }

????????????? else

????????????? {

?????????????????? //

?????????????????? //此處填寫你的代碼塊;

?????????????????? //

????????????? }

??????????????????? }

• 為注釋和代碼建立最大的行長度，以避免不得不滾動源代碼編輯器，并且可以提供整齊的硬拷貝表示形式。
• 在大多數(shù)運(yùn)算符之前和之后使用空格，這樣做時(shí)不會改變代碼的意圖。但是，C++ 中使用的指針表示法是一個(gè)例外。
• 使用空白為源代碼提供結(jié)構(gòu)線索。這樣做會創(chuàng)建代碼“段”，有助于讀者理解軟件的邏輯分段。
• 當(dāng)一行內(nèi)容太長而必須換行時(shí)，在后面換行代碼中要使用縮進(jìn)格式，如下：

string inserString = "Insert Into TableName(username,password,email,sex,address)"

+ "Values('Soholife','chenyp','soholife@sina.com','male','深圳福田')";

?

• 只要合適，每一行上放置的語句避免超過一條。例外是 C、C++、C# 或 JScript 中的循環(huán)，如 for (i = 0; i < 100; i++)。
• 編寫 HTML 時(shí)，建立標(biāo)準(zhǔn)的標(biāo)記和屬性格式，如所有標(biāo)記都大寫或所有屬性都小寫。另一種方法是，堅(jiān)持 XHTML 規(guī)范以確保所有 HTML 文檔都有效。盡管在創(chuàng)建 Web 頁時(shí)需折中考慮文件大小，但應(yīng)使用帶引號的屬性值和結(jié)束標(biāo)記以方便維護(hù)。
• 編寫 SQL 語句時(shí)，對于關(guān)鍵字使用全部大寫，對于數(shù)據(jù)庫元素（如表、列和視圖）使用大小寫混合。
• 在物理文件之間在邏輯上劃分源代碼。
• 將每個(gè)主要的 SQL 子句放在不同的行上，這樣更容易閱讀和編輯語句，例如：

????? SELECT FirstName, LastName

????? FROM Customers

????????? WHERE State = 'WA'

將大的復(fù)雜代碼段分為較小的、易于理解的模塊。

總結(jié)

以上是生活随笔為你收集整理的c#书写规范之---代码书写规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。