大家好,我是知微!
作為一個程式設計師,寫程式碼就跟廚師做菜一樣,如果沒有一些好的方法和習慣,做出來的菜肯定又慢又難吃。
下面分享一些優秀的程式設計習慣,用了都說好!
1、規範的命名
命名是程式碼清晰度的關鍵。
變數、函式和類的命名需簡潔明瞭,並遵循專案中約定的命名規則,如駝峰命名法或下劃線分隔法。這樣你的程式碼會更易於理解和維護。
下面展示一下不規範和規範命名的C語言例子
不規範的命名:
// 不明確意圖的命名方式
int a; // 無法表達變數用途
float b; // 缺乏描述性
void doSomething(); // 動作描述不清
int dta; // 縮寫可能令人困惑,不容易理解
void procData(); // "proc" 是處理的縮寫,可讀性不強
// 示例程式碼片段
int rfq4351d; // 沒有任何意義的命名
void hndlrq() {
int qwk = 10; // 很難猜到 qwk 是什麼
// ... 更多的程式碼
}
規範的命名:
// 清晰、具有描述性的命名
int accountBalance; // 表明這是一個賬戶餘額
float interestRate; // 表明這是利率
void processOrder(); // 動作和目的明確
int customerData; // 用於儲存顧客資料
void processData(); // 更清晰的函式命名
// 示例程式碼片段
int requestId; // 明確表達了這是一個請求標識
void handleRequest() {
int maxRetries = 10; // 清晰表明這是最大重試次數
// ... 更多的程式碼
}
2、合理編寫註釋
程式設計師最討厭別人的程式碼不寫註釋,因為閱讀起來特別困難。
雖然前段時間很流行防禦式程式設計,不寫註釋,程式碼也儘量讓他人難讀懂。
但是該寫註釋的,咱還是得寫,這樣可以提高我們的效率。否則時間長了,自己不根本記得。
但是切記,註釋不要寫太細,因為後面程式碼改動,以前的註釋可能就不適用了,如果沒有及時更新,反而會誤導自己。
3. 隨時儲存程式碼並測試
修改程式碼後,應立即進行自測試以確保正確性。這叫步步為營,慢就是快。
不要等寫完一大段程式碼後才提交,這可以減少除錯的難度並及時發現問題。
我以前就犯過這樣的錯誤,覺得修改的程式碼邏輯不算特別複雜,就是量大一些而已。結果全部改完了之後,編譯執行。出來意想不到的結果,然後進入漫長的多執行緒除錯,簡直就是災難。
4、學會先思考邏輯後寫程式碼
程式設計更多的是思考,梳理邏輯,寫程式碼只是將你的想法表達出來。如果一上來就開始寫程式碼,而不去思考和設計,可以100%確定,寫出來的程式碼一定很爛。
5、閱讀官方文件
官方的文件,你也可以理解為說明書。有誰能比設計產品的人更瞭解產品呢?這些文件不僅質量非常高,通常內容也都是最新的。
所以,當你遇到問題的時候,有時候看看官方文件,反而比用搜尋引擎尋找解決辦法更快。
6、不要重複造輪子
每次你辛苦編碼想要實現的功能,很可能在開源社群已經有了特別棒的解決辦法。如果你能夠善用這些現成的資源和各種開源的程式碼庫,你的工作效率可以大大提高,輕鬆許多。
一個好的開源工具或庫通常具備以下特點:
- 開放原始碼,並且許可證較為寬鬆:這樣的輪子能夠讓你自由使用,甚至是在商業專案中,而不用擔心法律問題。
- 完善的文件和規範的程式碼:有詳盡文件的輪子易於理解和使用,規範的程式碼則保證了可讀性和可維護性。
- 友好的介面,最好還附有示例:介面設計得好的輪子可以簡化開發流程,如果附帶示例,能使你快速學會如何使用。
比如我這篇文章(點選跳轉)裡提到的定時器模組,日誌模組,多功能按鍵模組,你稍稍改改就能用上。
7、多讀多寫程式碼
怎麼理解多讀呢?這點就跟寫作一樣,沒有大量的輸入,你很難有好的輸出。
一學就會,一練就廢。要想擺脫這種情況,就需要多寫了。
8、預留開發時間
新的專案立項之初,一定會評估開發時間。
你要是不會評估開發時間,拍腦袋隨便定一個。時間長了,老闆肯定不同意。時間短了,開發中可能遇到的各種問題,到時候天天加班,緊趕慢趕,心神俱疲。一頭烏黑濃密的頭髮,沒多久就成了地中海。
所以,合理的預留開發時間,可以確保交付的質量,也能讓自己和團隊輕鬆一點。
9、大膽重構
不要害怕重構程式碼,好的設計不是一開始就有的,而且逐漸重構出來的。
透過重構,你可以改進程式碼結構,提高程式碼的可讀性和可維護性 。而這種活,應該貫徹整個開發過程,你也會因為重構,使自己的程式設計能力得到極大的提升。
10、 善用程式碼管理工具,定時備份
我接觸到的有些程式設計師,每寫一版程式碼,都是複製一份,而且不備份。說實話,我看著都擔心,如果某一天硬碟壞了,那麼之前的努力就全部白費了。碰到專案緊急的時候,你就算007都不一定來得及了。
用git
或者svn
這樣的軟體來管理程式碼,一方面可以防止資料丟失,另一方面可以在程式出現錯誤的時候方便資料回滾。
以上就是今天要分享的內容了!
📢歡迎各位 👍點贊 ⭐收藏 📝評論,如有錯誤請留言指正,非常感謝!