寫代碼需要注意的地方

以下屬於個人總結,如有更好的方法或錯誤歡迎評論指出。

一、命名:一個好的命名讓代碼的可讀性更強。(希望大家評論給出自己更好的命名方法,我再更新到這)

1)類名需要儘可能的簡約(不超過三個業務描述的單詞,超過了可以縮寫某個單詞或直接省略);例如 用戶控制類 UserController,用戶日誌控制類 UserLogController,登錄用戶新增日誌控制類 LoginAddLogController(這裏省略了用戶單詞)

2)方法名可以描述更具體特別是帶查詢條件方法;例如 通過名稱,班級id查詢用戶集合,可以selectUserByClassIdAndUserName

假如你寫成selectUser,如果還有一個查詢用戶的方法那麼就不好區分了。

3)數據庫命名同樣需要簡約 需要注意的是數據庫不區分大小寫,用下劃線隔開關鍵字;且單詞較長的關鍵字需要縮寫。還有就是一些功能模塊劃分的前綴。例如:系統 用sys前綴 sys_user,配置 用base前綴 base_city,購物模塊可以 buy_cart 購物車表 。如果業務描述較複雜也可以省略某個單詞。

4)變量命名這個要求不是很嚴格,但總體來說也是需要簡約的。個人建議:傳入參數添加一個前綴 例如:inUserId,返回參數添加一個result單詞 例如 resultUserList,其他變量基本上是對象類的縮寫添加一些描述單詞。例如queryUser。

二、代碼格式  我發現很多新手寫代碼喜歡一個方法寫很多的業務邏輯。這樣可讀性極差,代碼的可複用性也差,且不易維護。我們寫代碼儘可能的是把一件事情分隔爲一個方法。一個方法超過100行我覺得就應該分子方法出來了。如果一開始你不能夠分離開這些方法,但是你可以等寫完之後再進行分離。標註出 第一步:xxxx;第二步:xxxx 這樣代碼層次清晰了,邏輯清晰了無形中可以避免一些奇怪的不易察覺的bug。我給一些新手查過奇怪的bug大多是因爲代碼寫的可讀性差導致很難自己發現bug。

三、寫代碼思路  其實對於老程序員來說寫代碼都不叫一個事噼噼啪啪就寫了給七七八八。那麼新手應該怎樣構思自己的代碼呢?

首先我們需要了解需求,知道我們要實現一個什麼樣的功能,怎麼去實現,邏輯是怎樣的,全部瞭解清楚了再動手。不要領到任務了就因爲時間趕就直接開寫,不清楚的地方到時候再說。一定要全部清楚了再寫,如果邏輯複製可以在紙上自己先寫一下捋順了再開始寫代碼。

四、工具的應用  對應現在的程序員來說是幸福的,因爲我們有大量的工具可以用。如果一些費時的事情,不妨先百度 Google一下有沒有輔助工具能夠幫你,或者自己寫一個腳本,程序工具。磨刀不誤砍柴工,一個好用的工具能夠節省你很多時間。早早就下班它不香嗎?

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章