成功的開(kāi)發(fā)團(tuán)隊(duì)要求隊(duì)伍中的每一位成員遵守代碼重用規(guī)則，這些規(guī)定把代碼的重用性推到極至同時(shí)卻不會(huì)顯著降低開(kāi)發(fā)人員的創(chuàng)造力和開(kāi)發(fā)效率。如果編寫和使用代碼的開(kāi)發(fā)人員遵守共同的程序命名規(guī)范代碼和代碼注釋要求，那么代碼的重用性就會(huì)得以大大提升。這些標(biāo)準(zhǔn)的起點(diǎn)是系統(tǒng)結(jié)構(gòu)級(jí)的。你的功能規(guī)范應(yīng)該在類、屬性的名字、函數(shù)返回值以及其他關(guān)鍵程序元素的定義中反映這些標(biāo)準(zhǔn)。本文將就基本的命名規(guī)則和注釋提出一些可行的建議，意圖幫助讀者開(kāi)發(fā)自己的代碼重用標(biāo)準(zhǔn)。?


大小寫標(biāo)準(zhǔn)


在我們開(kāi)始討論各類程序要素命名的正確方式之前，先讓我們定義區(qū)分元素的字符大小寫的兩種最常用方式，它們是：

Pascal規(guī)范—第1個(gè)字符大寫，目標(biāo)名中的每個(gè)單詞的第1個(gè)字母也大寫，比如InvoiceNumber或者PrintInvoice。其他的所有字符都小寫。?
Camel規(guī)范—第1個(gè)字符不大寫，但目標(biāo)名中的每個(gè)單詞的第1個(gè)字母大寫，比如，invoiceNumber。其他的所有字符都小寫。?
可是，采用字符大小寫區(qū)分元素可能在對(duì)大小寫不敏感的編程語(yǔ)言中引發(fā)問(wèn)題。比方說(shuō)，由于C#語(yǔ)言區(qū)分大小寫，所以你可以調(diào)用私有變量employee，接著它所具有的公共屬性Employee則可以被調(diào)用者所用。這些操作是完全合法的。但是，對(duì)Visual?Basic來(lái)說(shuō)就會(huì)產(chǎn)生錯(cuò)誤，因?yàn)閂B是不區(qū)分字母大小寫的，以上兩種元素在VB看來(lái)都是一回事。假如你在混合語(yǔ)言環(huán)境下工作，你只能指定某些規(guī)則要求開(kāi)發(fā)人員合理利用多種語(yǔ)言閱讀其他人開(kāi)發(fā)的代碼。


命名標(biāo)準(zhǔn)
假設(shè)我們采用了以上的大小寫標(biāo)準(zhǔn)，現(xiàn)在就讓我們了解一些通用程序元素的簡(jiǎn)單命名建議。

類
某些類設(shè)計(jì)為模擬真實(shí)世界的對(duì)象，就這些類來(lái)說(shuō)，所選用的名字就應(yīng)該反映真實(shí)世界的對(duì)象、具有單數(shù)名詞的格式，比方Employee、?Invoice或者Timecard等。對(duì)內(nèi)部類而言可以采用Pascal規(guī)范令結(jié)果類具有單數(shù)形式的名字，比如ThreadPool或者CustomColor等。 Employees 配列などの複數(shù)形で同じ型のコレクション名を表現(xiàn)できるように、クラスは単數(shù)形である必要があります。

類的成員
采用C#以及其他大小寫敏感編程語(yǔ)言的開(kāi)發(fā)人員應(yīng)當(dāng)采用camel規(guī)范命名類成員的名字。そうすることで、開(kāi)発者は內(nèi)部変數(shù)の名前とパブリック プロパティの名前を區(qū)別しやすくなります。多くの VB 開(kāi)発者は、クラス メンバーに名前を付けるためにハンガリー語(yǔ)の命名法を使用することを好みます。つまり、名前の前に接頭辭を追加して変數(shù)の型を示します。たとえば、sName は文字列型の Name 変數(shù)を指します。 VS.NET などの高度な開(kāi)発環(huán)境では、変數(shù)の上にマウスを置くとシステムの変數(shù)の型が自動(dòng)的に表示されるため、これを行う必要はないと思います。我個(gè)人喜歡在類成員名前加上前綴：小寫的字母m。這樣內(nèi)部變量就保存了足夠的內(nèi)部類信息：內(nèi)部變量mName就正好代表了公共屬性Name。

方法
方法應(yīng)該用Pascal規(guī)范命名，同時(shí)用合理的方式說(shuō)明他們的實(shí)施行為。比方說(shuō)，給數(shù)據(jù)庫(kù)添加雇員的方法可以命名為AddEmployee，而打印發(fā)票的方法則不妨命名為PrintInvoice。假如方法返回的是布爾值，那么方法名應(yīng)該以動(dòng)詞開(kāi)頭以便用在if語(yǔ)句的時(shí)候其含義更明顯。比如說(shuō)，假如你有一個(gè)方法的功能是確定某位雇員是否符合公司401k計(jì)劃的要求，那么你可以在If語(yǔ)句中調(diào)用IsEligible401k方法：If?IsEligible401k?then…

方法參數(shù)、返回值和變量
所有的方法參數(shù)、返回值和變量都應(yīng)該采用Pascal規(guī)范命名，同方法名一樣也應(yīng)該能反映參數(shù)或者變量所代表的含義。 IntelliSenseはメソッドを呼び出すときにパラメーター名とパラメータータイプを返すため、これはパラメーターメソッドにとって特に重要です。所有采用方法的開(kāi)發(fā)人員都應(yīng)該使用描述性的名字和類型，便于相互理解其含義。

控件
控件命名是開(kāi)發(fā)領(lǐng)域一個(gè)經(jīng)常引發(fā)爭(zhēng)議的問(wèn)題。雖然大多數(shù)人贊同不應(yīng)該使用控件的默認(rèn)名稱，比如TextBox1或者Label1等等，但是，他們還反對(duì)按照變量的方式命名控件或者采用前綴表示控件的類型。私は、フォーム上のコントロールに名前を付けるには、標(biāo)準(zhǔn)の 3 文字の接頭辭を使用することを好みます。比如說(shuō)，保存姓氏和名字的文本框控件就不妨分別命名為txtLastName和txtFirstName。處理窗體數(shù)據(jù)的命令按鈕則可以命名為cmdSubmit或者cmdCancel。実際、コントロールの命名が一貫しており、標(biāo)準(zhǔn)が理解しやすいことを確認(rèn)できる限り。

コメント
コメントコードは、すべての開(kāi)発者に必要です。適切なアノテーション技術(shù)を教えるために、私はデモ プログラムにアノテーション付きコードを追加することがよくあります。また、注釈のプロセスを簡(jiǎn)素化するために、開(kāi)発者は最初に、作成したいプログラムを説明するコメントを書くことをお?jiǎng)幛幛筏蓼?。まず、プログラム?nèi)のプロシージャ、クラス、またはその他のプログラム要素を説明するコメントを書きますが、それらがどのように機(jī)能するかについては説明しません。次に、プロセスの主要なステップやクラスの要素を説明する一連のコメント付きコードを作成します。クラスを定義したり、プロセスを説明したりするコードを記述した後、各外部変數(shù)、コントロール、開(kāi)いているファイル、さらには他のプロセスによってアクセスされる要素を文書化し、入力パラメーターと戻り値を簡(jiǎn)単に説明します。

C# を使用してプログラムを開(kāi)発している場(chǎng)合、VS.NET 環(huán)境には、內(nèi)部 C# コメントを外部 HTML ドキュメントに変換するのに役立つ組み込みツールがすでに組み込まれています。獨(dú)自のドキュメントに特別な処理ディレクティブを追加して、外部ドキュメントの表現(xiàn)方法を変更できます。詳細(xì)については、VS.NET 內(nèi)部ヘルプ ファイル ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcoriXMLDocumentation.htm を參照してください。