配置Eclipse和IDEA的Javadoc 和 阿里巴巴代碼規範檢測工具（p3c)

前言

因爲看到了《阿里巴巴Java開發手冊（華山版）》，所以在Eclipse和IDEA中安裝了相應的插件，分別是Javadoc和阿里巴巴編碼規約掃描。

1. Eclipse

• p3c

1. 安裝
   Eclipse安裝p3c和普通的插件安裝一樣，這裏是阿里巴巴GitHub鏈接：
   https://github.com/alibaba/p3c/tree/master/eclipse-plugin。
   按照上面的步驟完全可以安裝成功。

2. 測試
   安裝完成後需要重啓。
   編寫一個簡單代碼測試：
   
   運行阿里巴巴編碼規約掃描：
   右鍵 -> 阿里巴巴編碼規約掃描
   
   可以看到掃描結果：
   
   第一個問題是類名，這裏將P3CTesting修改位P3cTesting。
   第二個問題是沒有添加類的註釋信息，添加即可（博主已經配置了註釋模板）。

再次掃描：

• Javadoc
  Javadoc不用安裝，直接使用即可。
  點擊Project -> Generate Javadoc
  
  配置如下：
  第一個框選擇自己已經安裝的JDK目錄下的javadoc.exe。
  第二個框選擇自己要使用的類，可以選擇整個項目，博主這裏只選擇剛纔寫的類。
  第三個框生成doc文件的目錄，默認選項。
  
  點擊Next：
  選擇：
  
  點擊Next，設置編碼格式：
  -encoding UTF-8 -charset UTF-8
  
  點擊Finish：
  

項目目錄下會生成doc目錄，瀏覽器打開index.html：

結果（有沒有感覺網頁排版在哪裏見過，哈哈。）：

2. IDEA

IDEA使用插件安裝即可：
File -> Settings -> Plugins
分別搜索安裝JavaDoc 和 Alibaba


安裝完成後需要重啓。。。

測試

創建一個Java項目：
右鍵運行編碼規約掃描：

運行結果：

可以看到與Eclipse中的檢測結果一致。

修改類名，和添加註釋後，再次掃描：
左下方提示沒有發現可以代碼。。。

生成Javadoc：
Tools -> Generate JavaDoc

設置參數：

結果：

查看：

完！