轉自:蘇格拉大魔王
說一些基礎的、適用於初學者的好習慣。
#1 – 在開始編碼之前先規劃和組織程式碼
在專案的開始階段,不要上手直接寫程式碼,一定要先確定程式碼的分層和架構。該分層和架構在一定程度上決定了未來整個專案的程式碼風格和維護性,對於專案的長期維護,程式碼架構的設計是一件非常重要的事情。
程式碼架構可以提供更好的可讀性和可維護性。
大家可能還記得剛開始寫程式碼的時候,所有的程式碼都會集中在一個檔案,甚至一個函式中,比如:
隨著需求的增長,程式碼量的擴大,這樣的程式碼是很難閱讀和進行維護的,於是我們會使用重構的手段去讓程式碼更便於維護和閱讀:
進一步,我們將程式碼分散在不同的檔案、檔案夾中,透過良好的命名,我們甚至可以在不去看具體的程式碼實現的情況下,僅僅透過檔案名就能判斷出在做的事情:
│ main.c
│
├───job
│ first.c
│ second.c
│ third.c
│
└───other
other file
就檔案來說,可以從檔案名上,分清哪些是頭檔案、哪些是源檔案、哪些是第三方庫、還有各種功能模組的細分等。
就程式碼來說,包括統一的命名風格,封裝在同一個檔案裡的程式碼的相關性足夠強等。
一個好的架構還應該盡可能的提高程式碼的可擴充套件性。
你要知道需求變更太TM正常了,新增需求也太TM正常了。因此好的架構,必須要考慮到這些情況的發生,因為他們是一定會發生的。 所以,一定要避免把程式碼寫死。
#2 – 避免大塊重覆程式碼,小塊也不行
一個非常好的程式設計習慣是確保為程式碼建立函式或類,以便有時重用。當你的編碼過程中多次出現重覆的程式碼塊,這樣很臃腫、很雞肋,你就應該想他們是否應該封裝成一個函式或類。
專門為可以反覆使用的功能構建專用檔案。例如,資料庫呼叫(例如開啟資料庫連線,選擇資料,插入資料,更新資料,刪除資料和關閉連線)都應該轉換為函式。透過不必重寫冗餘程式碼行,也會使你的工作變得更加容易。你需要做的就是呼叫該函式,簡單、清潔、而且容易。
例如,以下是將記錄插入MySQL資料庫的PHP函式示例:
#3 – 使用易於閱讀的命名約定
無論你正在開發什麼型別的程式碼,命名約定都很重要。你建立的變數名稱,函式名稱,類名稱和任何其他程式名稱越人性化,你後續的開發和取用就會越容易。因為所有程式碼並不都是同一天寫的,而且一個專案往往由很多人共同參與,好的命名約定可以大大提高編碼效率,還可以降低你在同事心中的傻逼程度。
例如,不是寫這個:
而是應該這樣寫:
#4 – 註釋所有程式碼,即使它看起來很明顯
就算它寫在臉上,也一定要註釋、註釋、註釋。因為當你正在處理程式碼的時候,它肯定是易懂的,不然你也寫不出來這樣的程式碼。但是,當你再次回到該程式碼時,你可能
而且這也會大大減輕同事的負擔,換位思考一下,假如老大讓你改一下同事A沒有註釋的程式碼,可能改一下只需要2個小時,看懂得兩天,你心裡肯定萬匹草泥馬奔騰。
特別是如果該程式碼中有大量巢狀元素。對這樣的程式碼塊的右括號進行註釋也是一種好習慣。
#5 – 在構建時測試和除錯程式碼
每次建立程式碼塊時,都應該對其進行測試和除錯,以確保它正常工作。不要蒙頭就是寫,然後寫完了之後在除錯,避免為了找到錯誤而篩選數百或數千行程式碼。不僅需要在構建程式碼時測試和除錯程式碼,還需要確保開啟所有錯誤報告,以便在實際操作中實際檢視錯誤。比如PHP,你還需要確保在php.ini檔案或user.ini檔案中開啟這些設定,該檔案通常位於根目錄中。
在程式碼的頂部,應該使用:
在php.ini或user.ini檔案中,應該修改以下陳述句:
#6 – 實現版本控制系統
版本控制是程式設計的一個重要方面。當你構建一個簡單的軟體時,你可能不會在一開始就考慮版本控制。但是,隨著時間的推移,你將需要改進該程式碼,無論它是什麼型別的程式碼。而且,隨著你的改進,你將需要跟蹤你的版本。請記住,程式設計不只是編寫程式碼行,你必須能夠正確地組織程式碼並跟蹤你的工作。
保留版本也是很好的,這樣你就可以不時地檢查一下,看看你在之前的版本中做了什麼,或者可能帶回你在先前版本中刪除但現在想要重用部分的程式碼。這是一個很好的習慣。因此,你需要一個可以控製版本的工具比如git。
#7- 多吃枸杞,養生、護髮、防猝死。
朋友會在“發現-看一看”看到你“在看”的內容