新聞中心
C#項(xiàng)目開(kāi)發(fā)實(shí)例中,對(duì)于規(guī)范的制定,是很重要的要求。合理的方法名,合適的命名都是C#項(xiàng)目開(kāi)發(fā)實(shí)例中規(guī)范的內(nèi)容,可大大提高系統(tǒng)的可維護(hù)性和健壯性,并可使系統(tǒng)關(guān)系清晰。

十余年建站經(jīng)驗(yàn), 成都網(wǎng)站設(shè)計(jì)、成都網(wǎng)站建設(shè)客戶的見(jiàn)證與正確選擇。成都創(chuàng)新互聯(lián)公司提供完善的營(yíng)銷(xiāo)型網(wǎng)頁(yè)建站明細(xì)報(bào)價(jià)表。后期開(kāi)發(fā)更加便捷高效,我們致力于追求更美、更快、更規(guī)范。
表意清晰的命名規(guī)范是程序規(guī)劃的核心,如果整個(gè)系統(tǒng)所有的命名都與其功能相適合,并可以讓人“望文知意”,例如“Age”、“SetAge ()”,可大大提高系統(tǒng)的可維護(hù)性和健壯性,并可使系統(tǒng)關(guān)系清晰。反之,如果命名不能反應(yīng)其含義,例如“v001”、“f002 ()”,那么將適得其反。
|
[[5474]]說(shuō)明 |
常用的命名風(fēng)格如下。 (1)Pascal風(fēng)格:包含一到多個(gè)單詞,每一個(gè)單詞***個(gè)字母大寫(xiě),其他字母小寫(xiě),其余字母均小寫(xiě)。例如:CollegeStudent、HelloWorld等。 (2)Camel風(fēng)格:包含一到多個(gè)單詞,***個(gè)單詞首字母小寫(xiě),其余單詞首字母大寫(xiě),其他字母均小寫(xiě)。例如:name、gender、somePara等。 |
下面就給出常用的一些命名規(guī)范,供讀者在開(kāi)發(fā)中參考。
1.命名空間
命名空間命名采用Pascal風(fēng)格,取名的一般規(guī)則如下。
CompanyName.TechnologyName
例如:
Microsoft.Office
MyCompany.NamingRule.Test
另外,需要用復(fù)數(shù)的時(shí)候要使用復(fù)數(shù)的名稱空間名。例如,使用System.Collections而不是System.Collection。但是,當(dāng)遇到縮寫(xiě)形式時(shí),通常不需要使用復(fù)數(shù)。例如:使用System.IO而不是System.IOs。
名稱空間和類(lèi)不能使用同樣的名字。例如,有一個(gè)類(lèi)被命名為Student后,就不要再使用Student作為一個(gè)名稱空間。
2.類(lèi)
C#中的類(lèi)命名采用Pascal命名風(fēng)格,取名的規(guī)則如下。
(1)在為類(lèi)命名前首先要知道該類(lèi)的作用,盡量以名詞或名詞短語(yǔ)命名,使程序員通過(guò)類(lèi)名提供的線索,便可以了解這個(gè)類(lèi)的基本功能。
(2)盡量不使用縮寫(xiě),而用全寫(xiě)。例如:使用CollegeStudent而不用CollegeStu。
(3)不要使用任何類(lèi)前綴(例如C)和后綴(例如Class)。
(4)不要使用帶下劃線的字符(例如College_Student)。
下面是一個(gè)合理的類(lèi)名的示例。
代碼19-1 類(lèi)命名示例
- ///
- /// 類(lèi)名:Pascal命名風(fēng)格,形如SomeClass。
- ///
- pulibc class CollegeStudent
- {
- …
- }
3.私有成員
類(lèi)的成員變量采用Camel風(fēng)格,并使用前綴m_或者_(dá)。下面是一些合理的私有成員示例。
代碼19-2 私有成員命名示例
- class CollegeStudent
- {
- ///
- /// 私有成員命名:Camel命名風(fēng)格,形如member。
- ///
- private string m_name;
- private int m_age;
- }
另外,有些程序員習(xí)慣于使用數(shù)據(jù)類(lèi)型前綴,用來(lái)確定參數(shù)的數(shù)據(jù)類(lèi)型。例如strName、nAge等,但這不是通用的規(guī)范。
4.屬性
類(lèi)的屬性采用Pascal風(fēng)格。下面是一些合理的屬性示例。
代碼19-3 屬性命名示例
- class CollegeStudent
- {
- ///
- /// 屬性命名:Pascal命名風(fēng)格,形如Name。
- ///
- public string Name
- {
- set
- {
- if(value!=null)
- this.m_name=value;
- }
- get
- {
- return this.m_name;
- }
- }
- }
5.方法
通常每個(gè)方法都是執(zhí)行類(lèi)的一個(gè)“動(dòng)作”,所以對(duì)方法的命名應(yīng)該清楚地說(shuō)明該方法是做什么的,用“動(dòng)詞+名詞”的結(jié)構(gòu)可以更加清晰的表達(dá)這種含義。例如,用ShowInfo()代替Info(),用LoadData()代替DataLoad(),這樣做的目的是更加明確這個(gè)方法的功能。
下面是一些合理的方法名示例。
代碼19-4 方法命名示例
- class CollegeStudent
- {
- ///
- /// 方法名:Pascal命名風(fēng)格,形如SomeMethod。
- ///
- public void EnterSchool() {…}
- }
另外,常常使用一些前綴來(lái)表達(dá)方法的含義,如下。
(1)Is的含義為問(wèn)一個(gè)關(guān)于某樣事物的問(wèn)題。例如:IsMale()。
(2)Get的含義為取得一個(gè)數(shù)值。例如:GetInfo()。
(3)Set的含義為設(shè)定一個(gè)數(shù)值。例如:SetInfo()。
6.方法參數(shù)
C#中,方法的參數(shù)采用camel風(fēng)格。另外,有些程序員習(xí)慣于使用數(shù)據(jù)類(lèi)型前綴,用來(lái)確定參數(shù)的數(shù)據(jù)類(lèi)型。例如strName、nAge等。
下面是一些方法參數(shù)命名的C#項(xiàng)目開(kāi)發(fā)實(shí)例。
代碼19-5 方法參數(shù)命名C#項(xiàng)目開(kāi)發(fā)實(shí)例
- class CollegeStudent
- {
- public void SetInfomation(string name,int age){…}
- }
7.接口
同方法相似,接口采用Pascal命名規(guī)范,取名的規(guī)則如下。
(1)使用I作為前綴,表示其為一個(gè)接口。
(2)使用名詞或名詞短語(yǔ),或者描述行為的形容詞來(lái)命名接口。例如IComponent(描述性名詞)、ICustomAttributeProvider(名詞短語(yǔ))和IPersistable(形容詞)。
(3)盡量不使用縮寫(xiě),而用全寫(xiě)。例如:使用IComponent而不用IComp。
(4)不要使用帶下劃線的字符(例如ICustom_AttributeProvider)。
例如:
代碼19-6 接口命名示例
- class CollegeStudent
- {
- ///
- /// 接口名:Pascal命名風(fēng)格,形如ISomeInterface。
- ///
- public interface IPlay{};
- }
8.變量
局部變量采用camel風(fēng)格,并盡量使用描述性強(qiáng)的名詞或名詞短語(yǔ),并且不使用縮寫(xiě),如使用number,而不使用num。下面是一些變量命名的示例。
- int number=0;
- string sqlString=””;
- double averageScore=0.0;
- CollegeStudent collegeStudent=new CollegeStudent();
當(dāng)前標(biāo)題:C#項(xiàng)目開(kāi)發(fā)實(shí)例之規(guī)范的制定
轉(zhuǎn)載來(lái)源:http://fisionsoft.com.cn/article/dhiosgh.html


咨詢
建站咨詢
