歡迎來到Linux教程網
Linux教程網
Linux教程網
Linux教程網
Linux教程網 >> Linux基礎 >> Linux教程 >> 如何很好的Review自己的代碼

如何很好的Review自己的代碼

日期:2017/2/28 13:54:54   编辑:Linux教程

寫這篇博文的原因是因為自己寫的代碼經常會因為返工,delay項目的交付日期。總結了一下引起項目delay的原因,大概有如下幾點:

1.在沒有完全深熟悉需求交互細節的情況下;諸如根據不同渠道設置不同的訂單狀態變更--超時提醒和訂單取消功能。

2.在沒有想清楚自己代碼如何實現業務邏輯的情況下;諸如對騎手排班--明天到當前周期結尾的排班及排班詳情展示。

3.是否對業務邏輯有完整的測試用例;商家詳情權限功能和可逆向加密算法的測試用例。

往往第一步和第二步是同時出現的,第二步的出現也在很大程度上源自於對需求交互細節的理解不到位,所以我們在開發中養成的習慣應該是這樣的:

1.認真看需求分析,最好能復述出需求細節;構思自己代碼如何實現該邏輯。

2.多溝通,與產品經理與前端工程師、測試工程師溝通清楚需求交互細節。

當然上面總結的還都是理論,我們在開發中應該以此為指導,慢慢養成良好的開發習慣。注解的使用。當跟別人一起開發某個功能,很可能由於方法取名的問題,寫了重復的方法,在代碼Review的時候,可以在方法上添加@Deprecated的注解,表示該方法是過時的,當有應用調用該方法的時候,會報錯。

<!-- 注解的使用示例 -->

public class AnnotationTest extends Test
{

@SuppressWarnings("deprecation")
public static void main(String []args)
{

<!--這句話是程序命令。執行的操作是當程序結束的時候運行垃圾回收-->
System.runFinalizersOnExit(true) ;
sayHello();
AnnotationTest t=new AnnotationTest() ;
t.show() ;
}

<!--在方法上使用該方法,在使用該方法處會報錯-->
@Deprecated
public static void sayHello()
{
System.out.println("hello ,world!");
}

@Override
public void show()
{
System.out.println("super class");
}

}


public class Test {
@Deprecated
public void show()
{
System.out.println("super class");
}
}

上面是使用@Deprecated、@SupressWarning、@Overrider三個注解的示例,注解會被javac所識別,解析為注解類,編譯器會根據不同的注解,編譯出不同的結果,@Deprecated注解表示過時的方法,在使用低版本的JDK中方法的時候會出現;@SurpressWarning("deprecation")注解是抑制過時API的警告 ,這個可以放在調用過時的API的方法外部或者調用方法之前,那麼在編譯的時候javac遇到這個標識,即使知道API過時那麼也不會輸出過時API的提示。

<!--使用頻率80%-->
Alt + '/' 代碼提示
sysout + Alt + '/' 自動補全“System.out.println();”
public void AnnotationTest 雙擊類名Annotation,點擊Run As->Java Application,即可以運行該測試類
Ctrl + '/' 為光標所在的行添加注釋"//",不需要事先選中該行,取消注釋也是Ctrl + '/'
Ctrl + Shift + '/' 添加注釋"/* */",需要事先選中該行,取消注釋使用Ctrl + Shift + '\'
Ctrl + Shift + 'C' 添加多行注釋"//",取消注釋同樣使用Ctrl + Shift + 'C'
Ctrl + 'D' 刪除當前行
Ctrl + 'M' 最大化和最小化當前光標所在的IDE窗口
Ctrl + 'L' 跳轉到指定的所輸入的行標數
Ctrl + Shift + 'T' 查找工作空間內的指定類名
Ctrl + Shift + 'O' 慎用,因為有時候import的包不是你所需要的包
Alt + '<-' 和 Alt + '->' 跟蹤光標的上一個位置和下一個位置

Alt + Shift + 'J' 添加注釋,該注釋方便Eclipse生成API文檔,

附:

1.Eclipse安裝眼睛保護色主題,可以直接打開 Help -> Eclipse Marketplace 搜索Eclipse Color Theme來進行安裝:安裝完之後就可以在(Window->Preferences->General->Apperance->Color Theme)中找到顏色主題插件的設置界面了,在這裡可以根據自己的喜好選擇自己喜歡的主題了。

2.Eclipse中設置注釋標簽@User的三種方式:第一種,在Eclipse安裝目錄中的eclipse.ini中添加一句 -vmargs -Duser.name=Sun, Wu-Kong;第二種,通過菜單 Window->Preference -> Java -> Code Style -> Code Templates 在右側選擇Comments,將其中的Types項,然後選右邊的"Edit",進入編輯模式,將 @author ${user} 中的${user}改成你自己的名字即可;第三種,計算機-->管理-->本地用戶和組-->用戶,使用管理員賬戶登陸 可以任意修改用戶名 ,然後重啟電腦。

3.Eclipse中的項目如何生成javadoc文檔,項目列表中按右鍵,選擇Export(導出),然後在Export(導出)對話框中選擇java下的javadoc,提交到下一步,在Javadoc Generation對話框中有兩個地方要注意的:javadoc command:應該選擇本機安裝jdk路徑中的\jdk1.8.0_31\bin\javadoc.exe,destination:為生成文檔的保存路徑,可自由選擇,按finish(完成)提交即可開始生成文檔。接著可以看到Console控制台的輸出。

Copyright © Linux教程網 All Rights Reserved