1. 程式人生 > >Java eclipse如何生成JavaDoc

Java eclipse如何生成JavaDoc

如何使用eclipse生成javaDoc

  • 生成package-info.java
    • 新建包的時候勾選左下方的框框 將對文件的描述寫入此檔案中,具體的註解等尚未深究
  • 右鍵選擇專案Export,選擇javadoc
  • javadoc commond,選擇路徑為 jdk/bin/javadoc.exe
  • destintion 選擇匯出的位置 由自己選擇
  • 最後一步 在vm options中寫入防止gbk編碼問題

-encoding utf-8 -charset utf-8 - 到生成javadoc的地方開啟瀏覽器即可看到效果

javadoc的規範

  • 1.參考jdk原始碼內的文件規範
  • 2.參考effective java中對此的解讀
    • 簡潔易讀
    • 引數,返回值
    • 前置條件,後置條件,副作用
    • 執行緒安全
    • 序列化性
    • 允許html 但是需要轉義