如何让编码更加的标准
生活随笔
收集整理的這篇文章主要介紹了
如何让编码更加的标准
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
1.概述
在寫這片博文時,我也是思緒良久,參考了不同語言的編碼風格,最后總結出如何讓自己的編碼更加標準。
2.基礎
以Java的基礎為例子來說明:
- 文件編碼格式為UTF-8
- package需要置于最頂層
- import包時,使用eclipse的快捷鍵(command+1)倒入對應的包(這樣我們可以不用考慮包的順序如何排列)
- 格式化代碼采用eclipse的快捷鍵(command+shift+f)進行格式代碼
- if,else,for,while等語句,必須加上大括號({}),即使語句為空
- 代碼塊縮進,采用2個空格
- 列限制在120個字符,對于超過120個字符的語句或方法建議重構(這樣方便閱讀,及代碼的美觀性)
- tab鍵默認采用4個字符的長度
3.規范
在編寫代碼時,需要注意一下規范:
在進行邏輯判斷時,else語句必須添加,即使,else語句為空,也得添加在if語句后面
1 public void getAppDetail(App app){ 2 3 if(app != null){ 4 // 業務邏輯處理 5 }else{ 6 // 若沒有業務邏輯處理,此處也需要加上,可以打印一條log 7 log.info("App object is null"); 8 } 9 10 }在書寫switch語句時,default需要加上,即使它什么代碼也不包含
switch(index){case 1:// 調用邏輯方法break;case 2:// 調用邏輯方法break;default:// 不涉及任務業務,打印日志信息log.info("Index is undefined");break; }在進行代碼塊注釋的時候,需要注意,但行可以使用 /* ... */,也可以使用 // ... 。對于多行的 /* ... */注釋,必須從 * 開始,并且與前一行的 * 對其。以下為范例:
// 當行注釋/* 當行注釋 *//** 多行* 注釋*/關于命名約定可以參考,如何讓命名變得優雅。
在書寫try ... catch語句時,建議catch語句中只設計輸出日志信息(或者將異常拋出),不涵蓋業務邏輯處理。
try{// 業務邏輯處理 ...... }catch(Exception e){// 打印對應的異常信息log.error(String.format("Error message is %s",e)); }try{// 業務邏輯處理 ...... }catch(Exception e){// 拋出對應的異常信息throw new Exception(); }4.總結
冰凍三尺非一日之寒,要養成好的風格也非一朝一夕能完成,這需要我們自己在平時編碼的時候去注意這些細節,并且嚴格的要求自己。亡羊補牢,為時不晚,特寫此博文,與君共勉。
聯系方式:?郵箱:smartloli.org@gmail.com?
Twitter:https://twitter.com/smartloli?
QQ群(Hadoop - 交流社區1):424769183?
溫馨提示:請大家加群的時候寫上加群理由(姓名+公司/學校),方便管理員審核,謝謝!?
熱愛生活,享受編程,與君共勉!
本文轉自哥不是小蘿莉博客園博客,原文鏈接:http://www.cnblogs.com/smartloli/,如需轉載請自行聯系原作者
總結
以上是生活随笔為你收集整理的如何让编码更加的标准的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【算法】快速排序算法的编码和优化
- 下一篇: Linux安装压缩版的mysql