[[421077]]

今天，我們來聊一聊程序員經(jīng)常會犯的5個錯誤：

錯誤1：沒有文檔

所有項目的第一個錯誤就是：沒有任何文檔。

沒有文檔，如何開始呢?你如何了解項目結(jié)構(gòu)、軟件體系結(jié)構(gòu)，以及在哪里找到你想要修改、更新的文件，文檔是項目成功的關(guān)鍵，無論開源與否，你都需要確保自己記錄了如何使用項目、如何測試和部署項目。而且有一些很好的項目可以幫助你編寫文檔，比如docusaurus。

錯誤2：注釋

即使你有文檔，你仍然需要理解代碼，即使你是為自己編寫代碼，你仍然可能不記得某個特定代碼段在做什么，或者它是如何使用的，當然，你不需要為函數(shù)int addToNumbers(int v1, int v2)編寫注釋，但可能需要為函數(shù)computeQuotaForUser(int userId)添加一些注釋，比如在代碼不明顯或在多個關(guān)鍵代碼不明顯在或在多個關(guān)鍵代碼路徑上使用時進行注釋。

錯誤3：不可讀的代碼

你是否曾經(jīng)花了好幾個小時去閱讀一段代碼并理解它的作用(尤其是在沒有注釋的情況下)，每個開發(fā)人員都有這樣的時刻。所以，你要確保自己的代碼是可讀的，不僅要在不明顯的代碼上添加注釋，此外，還應(yīng)在整個代碼庫中采用一致的風(fēng)格。比如變量如何命名(例如，喜歡timeRemainingSeconds而不是timeremremaining)，編寫可以直接在屏幕上顯示完整的簡短的代碼單元(大概40行左右)。 

錯誤4：沒有測試

另一個錯誤也是最大的錯誤是永遠不要進行任何單元或集成測試。當然，你手動測試了代碼，可以確保它可以在你的機器上運行，但是不能保證你的同事將運行相同的測試，并且也不能保證代碼在干凈的環(huán)境中運行(例如CI/CD管道)。

要確保代碼能順利運行，編寫單元測試，并在CI/CD管道中的每個更改時都運行它們。

錯誤5：盡量不要使用強類型

許多語言(例如JavaScript或Python)都不使用強類型。他們通過引入相應(yīng)類型來解決這些問題(作為額外層的一部分——就像TypeScript，作為可選模塊的一部分——就像Python)。

強類型會引起一些問題，一些開發(fā)人員仍在使用字符串和整數(shù)做相加，比如“1”+ 1等于2(它等于11)。

這類問題通常很難找到，而要找到罪魁禍首就像大海撈針。要避免此類問題，一定要慎重使用強類型，并始終聲明類型。