IT貓撲網(wǎng):您身邊最放心的安全下載站! 最新更新|軟件分類|軟件專題|手機版|論壇轉(zhuǎn)貼|軟件發(fā)布

您當前所在位置:首頁網(wǎng)絡(luò)編程.Net編程 → .Net平臺開發(fā)的技術(shù)規(guī)范與實踐精華總結(jié)

.Net平臺開發(fā)的技術(shù)規(guī)范與實踐精華總結(jié)

時間:2015/6/28來源:IT貓撲網(wǎng)作者:網(wǎng)管聯(lián)盟我要評論(0)

以下是本人對.Net平臺開發(fā)實踐的一些點滴總結(jié)。這里的技術(shù)規(guī)范主要是開發(fā)過程的代碼規(guī)范、數(shù)據(jù)庫設(shè)計規(guī)范、Com和.Net互操作規(guī)范;實踐精華是對技術(shù)實踐過程中的部分總結(jié)。

一、代碼規(guī)范

良好的代碼風格來自于同一的代碼規(guī)范。風格良好的代碼不僅具備可讀性和可維護性,同時也給人行云流水、賞心悅目之快感。

據(jù)Microsoft公司統(tǒng)計,基于微軟平臺的開發(fā)中,有70-80%的印度工程師在完成同類算法或者模塊時,使用的代碼基本一致;而相同的調(diào)查中只有20%的中國工程師們是基本一致的。這說明我們的代碼生產(chǎn)過程亟待規(guī)范。

實義命名

類型、變量、常量、方法等標識符一律采用對應(yīng)的英文實義;如果涉及到兩個獨立的實義單詞,則中間用下劃線間隔或者單詞首字母大寫(兩種方式都可以);如果標識符的長度超過了30個字母,則基本上以英文單詞發(fā)音的重讀音節(jié)取選出三個字母,如Repeater用rpt,Management用mgt。

大小寫規(guī)則

目前一般有兩種大小寫規(guī)則:

Pascal大小寫形式,所有單詞第一個字母大寫,其他字母小寫。

Camel大小寫形式,除了第一個單詞,所有單詞第一個字母大寫,其他字母小寫。

類名使用Pascal大小寫形式

public class HelloWorld(或者Hello_World,以下同,不再贅述)
{
...
}

方法使用Pascal大小寫形式

public class HelloWorld()
{
void SayHello(string name)
{
...
}
}

變量和方法參數(shù)使用Camel 大小寫形式

public class HelloWorld()
{
int totalCount = 0;
void SayHello(string name)
{
string fullMessage = "Hello " + name;
...
}
}

不要使用匈牙利方法來命名變量

以前,多數(shù)程序員喜歡把數(shù)據(jù)類型作為變量名的前綴而m_作為成員變量的前綴。例如: string m_sName;int nAge;

然而,這種方式在.NET編碼規(guī)范中是不推薦的。所有變量都用Camel 大小寫形式,而不是用數(shù)據(jù)類型和m_來作前綴。

用name,address,salary等代替nam,addr,sal。

別使用單個字母的變量象i,n,x 等。使用 index,temp等。用于循環(huán)迭代的變量例外:

如果變量只用于迭代計數(shù),沒有在循環(huán)的其他地方出現(xiàn),允許用單個字母的變量命名,而不是另外取實義名。

文件名要和類名匹配,例如,對于類HelloWorld,相應(yīng)的文件名應(yīng)為helloworld.cs。

縮進和間隔

縮進用TAB,不用 SPACES。

注釋需和代碼對齊。

遵循VS2005的自動對齊規(guī)則,不要人為的調(diào)整。

用一個空行來分開代碼的邏輯分組。

在一個類中,各個方法的實現(xiàn)體必須用空行間隔,大括弧"{}"需獨立一行。

在每個運算符和括號的前后都空一格。如:

If ( showResult == true )
{
for ( int i = 0; i < 10; i++ )
{
//
}
}

而不是:

if(showResult==true)
{
for(int i= 0;i<10;i++)
{
//
}
}

良好的編程習慣

避免使用大文件。如果一個文件里的代碼超過300~400行,必須考慮將代碼分開到不同類中。

避免寫太長的方法。一個典型的方法代碼在1~30行之間。如果一個方法發(fā)代碼超過30行,應(yīng)該考慮將其分解為不同的方法。

方法名需能看出它作什么。別使用會引起誤解的名字。如果名字一目了然,就無需用文檔來解釋方法的功能了。

一個方法只完成一個任務(wù)。不要把多個任務(wù)組合到一個方法中,即使那些任務(wù)非常小。

使用C# 的特有類型,而不是System命名空間中定義的別名類型。如:

int age;

string name;

object contactInfo;

而不是:

Int16 age;

String name;

Object contactInfo;

這么做是基于如下兩點原因:(1)規(guī)范性和一致性;(2)便于跨語言平臺的移植。

別在程序中使用固定數(shù)值,用常量代替。別用字符串常數(shù),盡量用資源文件。

避免使用很多成員變量,聲明局部變量,并傳遞給方法。

不要在方法間共享成員變量,如果在幾個方法間共享一個成員變量,那就很難知道是哪個方法在什么時候修改了它的值。必要時使用enum,別用數(shù)字或字符串來指示離散值。

別把成員變量聲明為 public或 protected。都聲明為private 而使用 public/protected 的Properties。

不在代碼中使用具體的路徑和驅(qū)動器名,使用相對路徑,并使路徑可編程。永遠別設(shè)想你的代碼是在"C:"盤運行。你不會知道,一些用戶在網(wǎng)絡(luò)或"Z:"盤運行程序。

應(yīng)用程序啟動時作些"自檢"并確保所需文件和附件在指定的位置。必要時檢查數(shù)據(jù)庫連接,出現(xiàn)任何問題給用戶一個友好的提示。

如果需要的配置文件找不到,應(yīng)用程序需能自己創(chuàng)建使用默認值。如果在配置文件中發(fā)現(xiàn)錯誤值,應(yīng)用程序要拋出錯誤,給出提示消息告訴用戶正確值。錯誤消息需能幫助用戶解決問題。

注釋

別每行代碼,每個聲明的變量都做注釋。在需要的地方注釋。

可讀性強的代碼需要很少的注釋,如果所有的變量和方法的命名都很有意義,會使代碼可讀性很強并無需太多注釋。行數(shù)不多的注釋會使代碼看起來優(yōu)雅。

如果因為某種原因使用了復(fù)雜艱澀的原理,必須為程序配備良好的文檔和詳細的注釋。

對注釋做拼寫檢查,保證語法和標點符號的正確使用。

二、數(shù)據(jù)庫設(shè)計規(guī)范

表格分類與命名

數(shù)據(jù)表的分類關(guān)鍵詞標簽:.Net平臺開發(fā)規(guī)范

相關(guān)閱讀

文章評論
發(fā)表評論

熱門文章 手把手教你用好LINQ to SQL手把手教你用好LINQ to SQL在.NET環(huán)境下為網(wǎng)站增加IP過濾功能在.NET環(huán)境下為網(wǎng)站增加IP過濾功能ASP.NET 如何避免頁面重新整理時重復(fù)送出ASP.NET 如何避免頁面重新整理時重復(fù)送出用Asp.net擴展ExtJS用Asp.net擴展ExtJS

相關(guān)下載

人氣排行 asp.net表單提交方法GET\POST在ASP.NET中如何判斷用戶IE瀏覽器的版本Asp.net中messagebox的實現(xiàn)方法Asp.net中的web.config配置在ASP.NET MVC中實現(xiàn)大文件異步上傳用Iformattable接口控制.Net中文本格式c#.Net經(jīng)典面試題目用Asp.net擴展ExtJS