Eclipse用法:使用Javadoc導出項目的API文檔

eclipse直接自動生成整個項目的API幫助文檔的小tipshtml

另外,eclipse加入doc註釋的快捷鍵:Shift+Alt+J
eclipse

本文將具體講述使用Eclipse開發工具導出項目的Javadoc文檔的步驟和常見的問題。

技術文檔是項目的重要組成部分,Javadoc則是Java技術文檔的基礎之一。Javadoc爲Java代碼生成一組便於使用的API文檔,做爲溝通工具,這些文檔可提供有益的幫助,使團隊成員理解其餘成員正在進行的工做。

固然,要得到良好的Javadoc文檔,要求源代碼中有精心編寫的有意義的註釋,對任何工具而言,這都是苛刻的要求。這不是本文的重點內容。

工具

原文連接
開發工具

可是原文中的最後一步:編碼

  1. VM options中填入-encoding utf-8
    -charset utf-8
    ,具體的編碼方式,根據你的項目 spa

的編碼方式決定。點擊Finish htm

注意:若是編碼方式不對,會出現編碼錯誤報錯!!! ip


我添加了charset反而會報錯,這一步空着反而沒有問題。。
utf-8

相關文章
相關標籤/搜索