編碼不規範很危險

最近的IT圈不是很太平,前有程序員與產品經理決戰紫禁之巔,後有刪庫跑路一說,又來了一個編碼不規範被祭天。作爲一個程序員不單單要有強健的體魄更要有刀槍不入的神功,要不然這是拿生命在編程啊。說起編程規範不得不提《阿里巴巴Java開發手冊》。以前這份手冊發佈出來的時候有下載下來看過,從中受益匪淺。那個時候也只是粗略的看了一遍,並沒有仔細的去閱讀和體會。畢竟自己還是個菜鳥需要繼續努力,決定再去看一遍。在此還要感謝同事的不殺之恩。

 這本手冊的涉及面很多,有編程規約,異常日誌,單元測試,數據庫等。對於程序員來說編程規約是決定了你是否會被祭天的決定因素重要原因。個人總結如下:

一、命名的風格 

我國傳統文化中,人的起名,本身就是作爲一種文化行爲,是有着一定的內涵的文化現象。取一個好名字,可以提現出不同的文化印象。有些名字氣血軒昂,不同凡響;有些名字精明幹練;有的名字給人感覺多才多藝;有的給人一種才華橫溢的感覺;如果代碼只寫給計算機看的,那麼你喜歡使用“隨緣命名法”也沒人在意,但是我們寫出來的代碼更多的時候是給人看的,所以我們的命名就需要讓別人一看就知道你寫的是什麼,你寫的東西能實現什麼。代碼的bug是必然存在的,好的命名風格可以給看你代碼的人省下很多時間,給你填坑也快一些。對此我總結了以下:

  • 通用:代碼中的命名不能以數字,下劃線,美元符號開頭或是以下劃線,美元符號結尾

  • 禁止中西合璧命名法,隨緣命名法;命名要有意義;縮寫語義要清晰

  • 包:包名統一用小寫,單詞不可用複數

  • 類:單詞首字母大寫風格;抽象類以Abstract開頭;測試類名以Test結尾;異常以Exception結尾

  • 使用設計模式類名以對應模式結尾;Service與Dao接口實現類以Impl結尾;枚舉類以Enum結尾

  • 方法:方法名採用駝峯命名法;測試方法以test開頭;使用設計模式方法名以對應模式結尾;

  • 變量:常量名或枚舉成員名稱全部大寫,單詞間採用下劃線分割;數組定義類型括號要緊挨

  • service/dao層方法前綴名稱:插入用insert/save;刪除用delete/remove;修改用update;獲取數據用get;獲取列表用list

二、做到高內聚,低耦合

耦合性與內聚性是模塊獨立性的兩個定性標準,將軟件系統劃分模塊時,儘量做到高內聚低耦合,提高模塊的獨立性,爲設計高質量的軟件結構奠定基礎。通俗來說,高內聚:就像是你作爲一個開發人員你就負責開發對應的功能,而不用去管開發完的軟件測試工作,測試有對應的測試人員去做。職責分明,功能單一便是高內聚。低耦合:就像是筆記本脫離了鍵盤,筆記本依舊能正常的使用,它們之間就是低耦合。當你在修改bug的時候,你需要閱讀有幾千行代碼的方法的時候你就會發現如果寫這段代碼的人那個時候遵循高內聚,低耦合,把功能封裝起來,那麼對於閱讀代碼的人來說是一個多麼幸福的事情。做好自己也是在幫助他人

三、代碼註釋

剛開始編程的時候覺得寫註釋不是那麼重要,反正代碼只有自己看,但是出來工作之後就會發現,註釋可以很大程度的提高代碼的可讀性,快速的瞭解代碼的功能,理解裏面代碼邏輯。Java中的註釋有兩種,多行註釋:/*內容*/,多行註釋也被稱爲javadoc註釋;單行註釋://;

總結如下:

  • 單行註釋:使用在被註釋語句上方另起一行,使用//註釋
  • 多行註釋:類,類屬性,類方法必須採用多行註釋
  • 所有類必須要被註釋上對應的創建者和創建日期
  • 方法必須註釋方法做什麼事情,實現什麼功能
  • 多行註釋好處:不進入類/方法即可懸浮提示對應的註釋信息;可以生成對應的API文檔

四、其他

  • 在使用equals的時候,必須要把不爲空的值放在左邊,把可能爲空的值放在左邊爲報空指針;
  • 方法有註解的時候必須要添加對應的註解;
  • 不使用過時的方法;

五、要學會使用工具,來規範我們的代碼,Eclipse 安裝阿里巴巴代碼規範插件

在eclipse中:Help->Install New Software

點擊-》add

名稱輸入:隨意都ok

url:https://p3c.alibaba.com/plugin/eclipse/update

 點擊ok選擇對應的插件同意協議安裝即可,安裝之後需要重啓。PS:JDK最好1.8

結語:

誰都可以編程,現在的程序員基本上是零門檻,只要你從網絡上載點教學視頻,學習個三個月就能上路了。車開上路難免有點飄,作爲一個程序猿,你能寫的出讓電腦看的懂的程序不是能耐,最重要的是要寫出能讓人看的懂的程序纔是能耐。話是這樣說,但是又有幾個人能夠做的到呢?我們只有不斷的去學習,去實踐。《阿里巴巴Java開發手冊》是能讓我我們碼出高效的一本書,值得一讀。做好自己也是在幫助他人。《阿里巴巴Java開發手冊》下載地址:http://techforum-img.cn-hangzhou.oss-pub.aliyun-inc.com/1528269849853/Java_manual.pdf

喜歡的朋友可以關注我的微信公衆號:

 

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