天天看點

編碼不規範很危險在eclipse中:Help->Install New Software結語:

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

編碼不規範很危險在eclipse中:Help->Install New Software結語:

 這本手冊的涉及面很多,有程式設計規約,異常日志,單元測試,資料庫等。對于程式員來說程式設計規約是決定了你是否會被祭天的決定因素重要原因。個人總結如下:

一、命名的風格 

我國傳統文化中,人的起名,本身就是作為一種文化行為,是有着一定的内涵的文化現象。取一個好名字,可以提現出不同的文化印象。有些名字氣血軒昂,不同凡響;有些名字精明幹練;有的名字給人感覺多才多藝;有的給人一種才華橫溢的感覺;如果代碼隻寫給計算機看的,那麼你喜歡使用“随緣命名法”也沒人在意,但是我們寫出來的代碼更多的時候是給人看的,是以我們的命名就需要讓别人一看就知道你寫的是什麼,你寫的東西能實作什麼。代碼的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

編碼不規範很危險在eclipse中:Help->Install New Software結語:

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

結語:

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

喜歡的朋友可以關注我的微信公衆号:PS:有許多關于程式設計的資源免費分享

編碼不規範很危險在eclipse中:Help->Install New Software結語:

繼續閱讀