易讀文檔下載器 PHP如何寫出易讀的程式碼

成功的開發團隊要求隊伍中的每一位成員遵守程式碼重用規則，這些規定把程式碼的重用性推到極至同時卻不會顯著降低開發人員的創造力和開發效率。如果編寫和使用程式碼的開發人員遵守共同的程式命名規範程式碼和程式碼註解要求，那麼程式碼的重用性就會得以大幅提升。這些標準的起點是系統結構級的。你的功能規範應該在類別、屬性的名字、函數傳回值以及其他關鍵程式元素的定義中反映這些標準。本文將就基本的命名規則和註解提出一些可行的建議，意圖幫助讀者發展自己的程式碼重用標準。
大小寫標準
在我們開始討論各類程序要素命名的正確方式之前，先讓我們定義區分元素的字符大小寫的兩種最常用方式，它們是：
Pascal規範—第1個字元大寫，目標名中的每個單字的第1個字母也大寫，例如InvoiceNumber或PrintInvoice。其他的所有字元都小寫。 
Camel規格—第1個字元不大寫，但目標名中的每個單字的第1個字母大寫，例如，invoiceNumber。其他的所有字元都小寫。 
可是，採用字元大小寫區分元素可能在對大小寫不敏感的程式語言中引發問題。比方說，由於C#語言區分大小寫，所以你可以呼叫私有變數employee，接著它所具有的公共屬性Employee則可以被呼叫者所用。這些操作是完全合法的。但是，對Visual Basic來說就會產生錯誤，因為VB是不區分字母大小寫的，而以上兩種元素在VB看來都是一回事。假如你在混合語言環境下工作，你只能指定某些規則要求開發人員合理利用多種語言閱讀其他人開發的程式碼。
命名標準
假設我們採用了以上的大小寫標準，現在就讓我們來了解一些通用程式元素的簡單命名建議。
類別
某些類別設計為模擬真實世界的對象，就這些類別來說，所選用的名字就應該反映真實世界的對象、具有單數名詞的格式，比方Employee、 Invoice或Timecard等。對內部類別而言可以採用Pascal規範令結果類別具有單數形式的名字，例如ThreadPool或CustomColor等。類別應是單數的，這樣它們的複數形式就可以代表同類的集合名，例如Employees數組等。
類別的成員
採用C#以及其他大小寫敏感程式語言的開發人員應採用camel規範命名類別成員的名字。這樣做可以讓開發者更容易區分內部變數的名字（name）和公共屬性的名字（Name）。許多VB開發者偏好採用匈牙利命名法為類別成員命名，也就是在名字前面加上前綴表示變數的類型，例如sName就指的是string類型的Name變數。我認為，在使用VS.NET這樣高級的開發環境下這樣做是不必要的，因為在這種情況下系統滑鼠停留在變數之上即可自動顯示變數的類型。我個人喜歡在類別成員名前加上前綴：小寫的字母m。這樣內部變數就保存了足夠的內部類別資訊：內部變數mName就剛好代表了公共屬性Name。
方法
方法應該用Pascal規範命名，同時用合理的方式說明他們的實作行為。比方說，為資料庫新增員工的方法可以命名為AddEmployee，而列印發票的方法則不妨命名為PrintInvoice。假如方法回傳的是布林值，那麼方法名稱應該以動詞開頭以便用在if語句的時候其意義更明顯。比如說，假如你有一個方法的功能是確定某位員工是否符合公司401k計畫的要求，那麼你可以在If語句中呼叫IsEligible401k方法：If IsEligible401k then…
方法參數、回傳值和變數
所有的方法參數、傳回值和變數都應該採用Pascal規範命名，同方法名稱一樣也應該能反映參數或變數所代表的意義。這點對參數方法特別重要，因為你在呼叫方法的時候智慧感知（Intellisense）會傳回參數名稱和參數類型。所有採用方法的開發人員都應該使用描述性的名字和類型，以便相互理解其意義。
控制
控制項命名是開發領域常引發爭議的問題。雖然大多數人同意不應該使用控制項的預設名稱，例如TextBox1或Label1等等，但是，他們也反對以變數的方式命名控制項或採用前綴表示控制項的類型。我比較喜歡採用標準的三字母前綴來命名窗體中控制項的名字。比方說，儲存姓氏和名字的文字方塊控制項不妨分別命名為txtLastName和txtFirstName。處理窗體資料的指令按鈕則可以命名為cmdSubmit或cmdCancel。其實，只要你能保證控制項命名的一致性而且標準易於理解即可。
註解
註解程式碼對所有開發人員來說都是必要的。為了教導正確的註解技術，我就經常在自己的示範程式中加入註解程式碼。同時，為了簡化註解過程，我建議開發人員先寫註解說明他們想寫的程式。我會先寫註解說明程式中的過程、類別或其他程式要素，但對其具體運作方式不做闡述。然後我會寫一系列的註解程式碼描述過程的每一主要步驟或類別的元素。在編寫了定義類別或說明過程的程式碼之後，我對各個外部變數、控制項、開啟的文件乃至其他過程所存取的元素文檔化，對輸入參數和傳回值做簡要說明。
如果你在使用C#開發程序，那麼VS.NET環境已具有內建的工具幫助你把內部C# 註解轉換為外部HTML文件。你可以在自己的文件中加上特殊的處理指示符而改變外部文件的表示方式。有關這方面的更多資訊可以參考VS.NET內部幫助文件： ms-help://MS.VSCC/MS.MSDNVS/csref/html/vcoriXMLDocumentation.htm. 

以上就介紹了易讀文件下載器 PHP如何寫易讀的程式碼，包括了易讀文件下載器方面的內容，希望對PHP教學有興趣的朋友有所幫助。