手把手教你使用 idea 生成漂亮的 javadoc 文檔

1、打開 idea,點擊 Tools-> Generate JavaDoc,這樣會打開生成 javadoc 文檔的配置頁面。

2、進(jìn)行配置:

標(biāo)注的是重要的部分,從上往下分別是配置 javadoc 的范圍,輸出文件夾路徑以及命令行參數(shù)。

這里的命令行參數(shù)很重要,因為只有使用 utf-8 編碼才能保證生成時可以正常處理中文字符,所以一定要加上:

-encoding utf-8 -charset utf-8

還可以配置那些注解需要生成,哪些權(quán)限類(private、package、protected、public)需要生成等等精細(xì)的控制。

還有一點需要注意,即不要勾選“Include test sources”,勾選后,生成時會造成很奇怪的錯誤。

3、配置好后,點擊生成按鈕,生成好后就會自動在瀏覽器打開進(jìn)行查看咯,是不是很棒O(∩_∩)O~

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,568評論 19 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong閱讀 22,942評論 1 92
  • 2017年4月19日,從西安出發(fā)到平遙。 平遙,這個詞出現(xiàn)在我的視野中是在高中的地理課本上。總覺得平遙這是一...
    愛吃甜橙的萬俟春楓閱讀 722評論 1 1
  • 今天9號 掐指日子一算 兩周后某大V就要做他的史上最大讀書會了 關(guān)于這大V我表示我的情緒情感是復(fù)雜的 一方面很佩服...
    Chris的另一個世界閱讀 299評論 0 0
  • 我曾多次思考過這樣一個問題,我們?nèi)祟悜?yīng)該以何種態(tài)度來面對在這顆星球上曾與我們一同繁衍的生靈。 我們一直有這樣的...
    昨夜有風(fēng)閱讀 224評論 0 0

友情鏈接更多精彩內(nèi)容