程式設計的 5 個良好習慣

2021-05-04 01:18:45 字數 3757 閱讀 8199

像其他語言一樣,開發人員可以用 php 編寫出各種質量級別的**。學習良好的程式設計習慣能夠提高**質量和效率。

根據具體的情況,一般的開發人員往往比優秀的開發人員的效率低 10%~20%。優秀的開發人員的效率更高,因為他們擁有豐富的經驗和良好的程式設計習慣。不良的程式設計習慣將會影響到效率。本文通過展示一些良好的程式設計習慣,幫助您成為更優秀的程式設計師。

這些良好的程式設計習慣不僅能提高效率,還能讓您編寫出在應用程式的整個生命週期中易於維護的**。編寫出來的**可能需要大量的維護;應用程式的維護是一筆很大的開支。養成良好的程式設計習慣能夠提高設計質量(比如模組化),從而使**更加容易理解,因此維護就更加容易,同時也降低維護成本。

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

1. 使用良好的命名。

2. 分成更小的部分。

3. 為**新增注釋。

4. 處理錯誤條件。

5. 切忌使用複製貼上。

下一小節將詳細介紹這些習慣。

使用良好的命名

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

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

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

清單 1. 不良習慣:含糊的或無意義的名稱

良好習慣:說明性強並且簡潔的名稱

清單 2 中的**體現了良好的程式設計習慣。新的方法名具有很強的說明性,反映了方法的用途。同樣,更改後的變數名也更具說明性。惟一的保持最短的變數是$i,在本清單中,它是乙個迴圈變數。儘管很多人不贊同使用過短的名稱,但在迴圈變數中使用還是可以接受的(甚至有好處),因為它明確表明了**的功能。

清單 2. 良好習慣:說明性強並且簡潔的名稱

我們鼓勵您將大的條件拆分為乙個方法,然後用能夠描述該條件的名字命名方法。這個技巧能夠提高**的可讀性,並且能夠將條件具體化,使之能夠被提取甚至重用。如果條件發生變化,更新方法也很容易。因為方法擁有乙個有意義的名字,所以它能反映**的用途,讓**更容易閱讀。

分成更小的部分

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

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

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

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

清單 3 展示了乙個很長的函式,其中存在很多問題。它完成很多件事情,因此不夠緊湊。它也不便於閱讀、除錯和測試。它要做的事情包括遍歷乙個檔案、構建乙個列表、為每個物件賦值、執行計算等等。

清單 3. 不良習慣:過長的函式

如果多編寫幾個這樣的方法,維護就成了真正的難題了。

良好習慣:易管理、功能專一的方法

清單 4 將原來的方法改寫為更加緊湊、易讀的方法。在這個示例中,將乙個很長的方法分解為幾個短方法,並且讓每個短方法負責一件事情。這樣的**對將來的重用和測試都是大有裨益的。

清單 4. 良好習慣:易管理、功能專一的方法

將長方法拆分為短方法也是有限制的,過度拆分將適得其反。因此,不要濫用這個良好的習慣。將**分成大量的片段就像沒有拆分長**一樣,都會造成閱讀困難。

為**新增注釋

要為**新增良好的注釋有時似乎和編寫**一樣難。要了解應該為哪些內容新增注釋並不容易,因為我們常常傾向於注釋**當前做的事情。注釋**的目的是不錯的主意。在函式的不是很明顯的頭部**塊中,告訴讀者方法的輸入和輸出,以及方法的最初目標。

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

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

清單 5 中的注釋僅告訴讀者**在做什麼 — 它正在通過乙個迴圈進行迭代或新增乙個數字。但它忽略了它為什麼做當前的工作。這使維護該**的人員不知道是否可以安全地更改**(不引入新缺陷)。

清單 5. 不良習慣:函式注釋過多或不足

良好習慣:帶注釋的函式和類

清單 6 中的注釋告訴讀者類和方法的目的。該注釋解釋了為什麼**在做當前的工作,這對未來維護**十分有用。可能需要根據條件變更而修改**,如果能夠輕鬆了解**的目的,則修改起來很容易。

清單 6. 良好習慣:帶注釋的函式和類

// get the actual name of the

function convertdayofweektoname($day)

echo("the name of the 0 day is: " . convertdayofweektoname(0) . "/n");

echo("the name of the 10 day is: " . convertdayofweektoname(10) . "/n");

echo("the name of the 'orange' day is: " . convertdayofweektoname('orange') . "/n");

?>

良好習慣:處理異常

清單 8 展示了以有意義的方式丟擲和處理異常。額外的錯誤處理不僅使**更加健壯,它還提高**的可讀性,使**更容易理解。處理異常的方式很好地說明了原作者在編寫方法時的意圖。

清單 8. 良好習慣:處理異常

雖然檢查引數是一種確認 — 如果您要求引數處於某種狀態,這將對使用方法的人很有幫助 — 但是您應該檢查它們並丟擲有意義的異常:

* 處理異常要盡量與出現的問題緊密相關。

* 專門處理每個異常。

切忌使用複製貼上

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

一定要注意,不要將**從應用程式的一部分複製貼上到另一部分。如果您採用這種方式,請停止這個不良的習慣,然後考慮將這段**重寫為可重用的。一般而言,將**放置到乙個地方便於日後的維護,因為這樣只需在乙個地方更改**。

不良習慣:類似的**段

清單 9 給出了幾個幾乎一樣的方法,只是其中的值不同而已。有一些工具可以幫助找到複製貼上過來的**(參見參考資料)。

清單 9. 不良習慣:類似的**段

良好習慣:帶引數的可重用函式

清單 10 展示了修改後的**,它將複製的**放到乙個方法中。另乙個方法也進行了更改,它現在將任務委託給新的方法。構建通用的方法需要花時間設計,並且這樣做使您能停下來思考,而不是本能地使用複製貼上。但有必要進行更改時,對通用的方法投入的時間將得到回報。

清單 10. 良好習慣:帶引數的可重用函式

結束語如果您在編寫 php **的過程中養成本文討論的良好習慣,您將能夠構建易讀、易理解、易維護的**。使用這種方式構建的易維護**將降低除錯、修復和擴充套件**所面臨的風險。

使用良好的名稱和更短的方法能夠提高**的可讀性。注釋**的目的有利於**理解和擴充套件。適當地處理錯誤會使**更加健壯。最後,停止使用複製貼上,保持**乾淨,提高可重用性。

怎樣養成良好習慣

美國心理學巨匠威廉 詹姆斯有一段對習慣的經典注釋 種下乙個行動,收穫一種行為 種下一種行為,收穫一種習慣 種下一種習慣,收穫一種性格 種下一種性格,收穫一種命運。習慣是一種長期形成的思維方式 處世態度,習慣是由一再重複的思想行為形成的,習慣具有很強的慣性,象轉動的車輪一樣。人們往往會不由自主地啟用自...

git使用的良好習慣

git作為分布式版本控制系統受到大眾的追捧。為了管理好我們的 更好的團隊協作,我們使用git來協助我們。乙個簡單的git專案分支主要有master,develop,hotfix.master 可發布到線上的分支 develop 開發分支 hotfix 緊急修復bug分支 開始新版本開發 建立新的分支...

使用 UNIX 的 10 個良好習慣

the linux cookbook 一書的作者 michael stutz 憑藉自己多年使用 unix 的經驗,總結了 10 個良好習慣,個人認為真的很受用,現摘要如下與大家分享。建立層級目錄 使用 mkdir 的 p 選項,如 mkdir p tmp a b c。解包到指定的目錄 使用 tar ...