代碼註釋十分重要,但利用率卻很低,如何將代碼中的註釋與開發過程緊密結合,實現程序員規範註釋習慣,可以通過Doc進行註釋檢查以及作爲項目文檔。接下來簡單介紹一下javaDoc導出。
第一步:編寫合理註釋
這就是一個簡單的測試用的java項目,裏面有一個用於測試list轉json的測試方法。
第二步:導出
右鍵項目-->導出,選擇javadoc,單擊下一步。
選擇要導出的項目以及導出類別(可以使用默認)
配置自變量(默認就行)
在這一步,導出格式默認GBK,如果你的項目編碼格式是UTF-8那就要加上這一句:
-encoding UTF-8 -charset UTF-8
在生成時發現另一個類中的doc方法註釋param沒有添加詳細說明,所以建議在使用javadoc導出時搭配checkStyle一同使用。
但並不影響doc的生成
在項目目錄下多了一個doc文件夾。打開真實路徑我們可以看一下html
打開index.html我們就可以看到這個項目的整體java代碼結構了。