如何很好的Review自己的代碼

来源:http://www.cnblogs.com/RunForLove/archive/2016/01/23/5015941.html
-Advertisement-
Play Games

寫這篇博文的原因是因為自己寫的代碼經常會因為返工,delay項目的交付日期。總結了一下引起項目delay的原因,大概有如下幾點:在沒有完全深熟悉需求交互細節的情況下;諸如根據不同渠道設置不同的訂單狀態變更--超時提醒和訂單取消功能。在沒有想清楚自己代碼如何實現業務邏輯的情況下;諸如對騎手排班--.....


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

  1. 在沒有完全深熟悉需求交互細節的情況下;諸如根據不同渠道設置不同的訂單狀態變更--超時提醒和訂單取消功能
  2. 在沒有想清楚自己代碼如何實現業務邏輯的情況下;諸如對騎手排班--明天到當前周期結尾的排班及排班詳情展示
  3. 是否對業務邏輯有完整的測試用例;商家詳情許可權功能和可逆向加密演算法的測試用例

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

  1. 認真看需求分析,最好能覆述出需求細節;構思自己代碼如何實現該邏輯。
  2. 多溝通,與產品經理與前端工程師、測試工程師溝通清楚需求交互細節。

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

 1 <!-- 註解的使用示例 -->
 2 
 3 public class AnnotationTest  extends Test
 4 {   
 5  
 6      @SuppressWarnings("deprecation")
 7      public static void main(String []args)
 8      {   
 9       
10             <!--這句話是程式命令。執行的操作是當程式結束的時候運行垃圾回收-->    
11           System.runFinalizersOnExit(true)  ;
12           sayHello();
13           AnnotationTest t=new AnnotationTest() ;
14           t.show() ;
15      }
16 
17      <!--在方法上使用該方法,在使用該方法處會報錯-->
18      @Deprecated     
19      public  static  void sayHello()
20      {
21           System.out.println("hello ,world!");
22      }
23  
24      @Override
25      public  void  show()
26      {
27           System.out.println("super class");
28      }
29  
30 }
31 
32 
33 public class Test {
34      @Deprecated
35      public  void  show()
36      {
37           System.out.println("super class");
38      }
39 }

 

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

 1 <!--使用頻率80%-->
 2 Alt + '/'  代碼提示
 3 sysout + Alt + '/'  自動補全“System.out.println();”
 4 public void AnnotationTest  雙擊類名Annotation,點擊Run As->Java Application,即可以運行該測試類
 5 Ctrl + '/'  為游標所在的行添加註釋"//",不需要事先選中該行,取消註釋也是Ctrl + '/'
 6 Ctrl + Shift + '/' 添加註釋"/* */",需要事先選中該行,取消註釋使用Ctrl + Shift + '\'
 7 Ctrl + Shift + 'C' 添加多行註釋"//",取消註釋同樣使用Ctrl + Shift + 'C'
 8 Ctrl + 'D'  刪除當前行
 9 Ctrl + 'M'  最大化和最小化當前游標所在的IDE視窗
10 Ctrl + 'L'  跳轉到指定的所輸入的行標數
11 Ctrl + Shift + 'T'  查找工作空間內的指定類名
12 Ctrl + Shift + 'O'  慎用,因為有時候import的包不是你所需要的包
13 Alt + '<-' 和 Alt + '->'  跟蹤游標的上一個位置和下一個位置
14 
15 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控制台的輸出。
  4. 更多快捷方式參考:http://jingyan.baidu.com/article/c275f6bac8e43ae33d756716.html

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 最經想改寫C用的配置讀取介面, 準備採用hash或二叉樹提到原先用的鏈表,提高查找效率. 就回顧一下二叉樹,這裡分享一下二叉查找樹,代碼很精簡的, 適合學習運用二叉樹查找.
  • 1/先在https://www.vagrantup.com 下載vagrantup ,對應平臺下載,並安裝,安裝後可以在命令行使用vagrant https://www.vagrantup.com/downloads.html 下載地址 mac:https://releases.hashic...
  • Java日期時間使用總結一、Java中的日期概述日期在Java中是一塊非常複雜的內容,對於一個日期在不同的語言國別環境中,日期的國際化,日期和時間之間的轉換,日期的加減運算,日期的展示格式都是非常複雜的問題。在Java中,操作日期主要涉及到一下幾個類:1、java.util.Date 類 Date ...
  • package dataStructure;import java.util.ArrayList;import java.util.Scanner;import java.io.*;class node { int to, dist; node(int t, int d) { ...
  • 主要介紹spring的容器事件是如何運作的,介紹之前當然要講它遵從什麼模式,什麼是事件,廣播器等等。
  • public struct NSSearchPathDomainMask : OptionSetType { public init(rawValue: UInt) public static var UserDomainMask: NSSearchPathDomainMask { get }...
  • iTop4412 irom啟動和Exynos4212 iROMBooting Guide是一樣的。製作itop4412 BL1的工具下載地址:http://download.csdn.net/detail/cj675816156/9101607iROM階段啟動流程本次介紹如何構建Exynos4412...
  • scanf()函數基礎擴充
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...