天天看點

php程式設計的好習慣

這些良好的程式設計習慣不僅能提高效率,還能讓您編寫出在應用程式的整個生命周期中易于維護的代碼。編寫出來的代碼可能需要大量的維護;應用程式的維護是一筆很 大的開支。養成良好的程式設計習慣能夠提高設計品質(比如子產品化),進而使代碼更加容易了解,是以維護就更加容易,同時也降低維護成本。

不良的程式設計習慣會造成代碼缺陷,使其難以維護和修改,并且很可能在修改時又引入其他缺陷。以下是 5 個良好的程式設計習慣,能夠幫助 PHP 代碼避免這些缺陷:

1.使用良好的命名。

2.分成更小的部分。

3.為代碼添加注釋。

4.處理錯誤條件。

5.切忌使用複制粘貼。

下面将詳細介紹這些習慣:

使用良好的命名

使用良好的命名是最重要的程式設計習慣,因為描述性強的名稱讓代碼更加容易閱讀和了解。代碼是否好了解取決于是否能在未來維護它。即便代碼不帶有注釋,如果它很容易了解,将大大友善日後的更改。這個習慣的目标是讓您編寫的代碼像書本一樣容易閱讀和了解。

不良習慣:含糊的或無意義的名稱

清單 1 中的代碼包含過短的變量名、難以辨認的縮寫詞,并且方法名不能反映該方法的功能。如果方法名給人的感覺是它應該做這件事情,而實際中它卻做另外的事情,這将帶來嚴重的問題,因為它會誤導人。

分成更小的部分

專心解決一個問題之後再繼續程式設計,這樣會讓您更輕松。在解決一個緊急的問題時,如果繼續程式設計,會使函數越來越長。從長遠來說,這并不是一個問題,但您要記得回過頭來将它重構為更小的部分。

重構是個不錯的主意,但您應該養成編寫更短、功能更集中的代碼。短的方法能夠在一個視窗中一次看完,并且容易了解。如果方法過長,不能在一個視窗中一次看完,那麼它就變得不容易了解,因為您不能快速地從頭到尾了解它的整個思路。

建構方法時,您應該養成這樣的習慣,讓每個方法隻完成一件事情。這個習慣很好,因為:首先,如果方法隻完成一件事情,那麼它就更容易被重用;其次,這樣的方法容易測試;第三,這樣的方法便于了解和更改。

不良習慣:過長的方法(完成很多件事情)

清單 3 展示了一個很長的函數,其中存在很多問題。它完成很多件事情,是以不夠緊湊。它也不便于閱讀、調試和測試。它要做的事情包括周遊一個檔案、建構一個清單、為每個對象指派、執行計算等等。

為代碼添加注釋

要為代碼添加良好的注釋有時似乎和編寫代碼一樣難。要了解應該為哪些内容添加注釋并不容易,因為我們常常傾向于注釋代碼目前做的事情。注釋代碼的目的是不錯的主意。在函數的不是很明顯的頭部代碼塊中,告訴讀者方法的輸入和輸出,以及方法的最初目标。

注釋代碼目前做什麼是很常見的,但這是不必要的。如果代碼很複雜,不得不注釋它目前在做什麼,這将暗示您應該重寫代碼,讓它更容易了解。學會使用良好的名稱和更短的方法,在不提供注釋說明其用途的情況下提高代碼的可讀性。

不良習慣:函數注釋過多或不足

切忌使用複制粘貼

您可以從其他地方将代碼複制粘貼到自己的代碼編輯器,但這樣做有利也有弊。好的一面是,從一個示例或模闆中複制代碼能夠避免很多錯誤。不好的一面是,這容易帶來大量的類似程式設計方式。

一定要注意,不要将代碼從應用程式的一部分複制粘貼到另一部分。如果您采用這種方式,請停止這個不良的習慣,然後考慮将這段代碼重寫為可重用的。一般而言,将代碼放置到一個地友善于日後的維護,因為這樣隻需在一個地方更改代碼。