1. 程式人生 > >javadoc生成說明文件

javadoc生成說明文件

JDK中可執行命令:javadoc和相關引數如下:

C:\Users\123>javadoc
javadoc: 錯誤 - 未指定程式包或類。
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
-overview <file>          從 HTML 檔案讀取概覽文件
-public                   僅顯示 public 類和成員
-protected                顯示 protected/public 類和成員 (預設值)
-package                  顯示 package/protected/public 類和成員
-private                  顯示所有類和成員
-help                     顯示命令列選項並退出
-doclet <class>            通過替代 doclet 生成輸出
-docletpath <path>        指定查詢 doclet 類檔案的位置
-sourcepath <pathlist>    指定查詢原始檔的位置
-classpath <pathlist>     指定查詢使用者類檔案的位置
-exclude <pkglist>        指定要排除的程式包列表
-subpackages <subpkglist> 指定要遞迴載入的子程式包
-breakiterator            計算帶有 BreakIterator 的第一個語句
-bootclasspath <pathlist> 覆蓋由引導類載入器所載入的
                           類檔案的位置
-source <release>         提供與指定發行版的源相容性
-extdirs <dirlist>        覆蓋所安裝擴充套件的位置
-verbose                  輸出有關 Javadoc 正在執行的操作的資訊
-locale <name>            要使用的區域設定, 例如 en_US 或 en_US_WIN
-encoding <name>          原始檔編碼名稱
-quiet                    不顯示狀態訊息
-J<flag>                  直接將 <flag> 傳遞到執行時系統
-X                        輸出非標準選項的提要


通過標準 doclet 提供:
-d <directory>                    輸出檔案的目標目錄
-use                              建立類和程式包用法頁面
-version                          包含 @version 段
-author                           包含 @author 段
-docfilessubdirs                  遞迴複製文件檔案子目錄
-splitindex                       將索引分為每個字母對應一個檔案
-windowtitle <text>               文件的瀏覽器視窗標題
-doctitle <html-code>             包含概覽頁面的標題
-header <html-code>               包含每個頁面的頁首文字
-footer <html-code>               包含每個頁面的頁尾文字
-top    <html-code>               包含每個頁面的頂部文字
-bottom <html-code>               包含每個頁面的底部文字
-link <url>                       建立指向位於 <url> 的 javadoc 輸出的連結
-linkoffline <url> <url2>         利用位於 <url2> 的程式包列表連結至位於 <url>
的文件
-excludedocfilessubdir <name1>:.. 排除具有給定名稱的所有文件檔案子目錄。
-group <name> <p1>:<p2>..         在概覽頁面中, 將指定的程式包分組
-nocomment                        不生成說明和標記, 只生成宣告。
-nodeprecated                     不包含 @deprecated 資訊
-noqualifier <name1>:<name2>:...  輸出中不包括限定符的列表。
-nosince                          不包含 @since 資訊
-notimestamp                      不包含隱藏時間戳
-nodeprecatedlist                 不生成已過時的列表
-notree                           不生成類分層結構
-noindex                          不生成索引
-nohelp                           不生成幫助連結
-nonavbar                         不生成導航欄
-serialwarn                       生成有關 @serial 標記的警告
-tag <name>:<locations>:<header>  指定單個引數定製標記
-taglet                           要註冊的 Taglet 的全限定名稱
-tagletpath                       Taglet 的路徑
-Xdocrootparent <url>             將文件註釋中出現的所有後跟 /.. 的 @docRoot 替
換為 <url>
-charset <charset>                用於跨平臺檢視生成的文件的字符集。
-helpfile <file>                  包含幫助連結所連結到的檔案
-linksource                       以 HTML 格式生成原始檔
-sourcetab <tab length>           指定源中每個製表符佔據的空格數
-keywords                         使程式包, 類和成員資訊附帶 HTML 元標記
-stylesheetfile <path>            用於更改生成文件的樣式的檔案
-docencoding <name>               輸出編碼名稱

1、使用命令生成文件:

注意:需要使用引數: -encoding utf-8 -charset utf-8 對文件註釋的中文進行編碼指定,預設為本作業系統下的編碼。

javadoc.exe -protected -splitindex -use -encoding utf-8 -charset utf-8 @C:\Users\123\AppData\Local\Temp\javadoc2args.txt -d C:\Users\123\Desktop

引入檔案內容(C:\Users\123\AppData\Local\Temp\javadoc2args.txt):



com.shu.secondsection
-sourcepath
"C:/Users/123/IdeaProjects/ThinkingInJava/src/main/resources;C:/Users/123/IdeaProjects/ThinkingInJava/src/main/java;C:/Users/123/IdeaProjects/ThinkingInJava/src/test/java"

ntelliJ IDEA作為Java流行的編輯器, 其生成一些Javadoc會對中文亂碼, 使用UTF-8編碼即可. 這個常見的問題, 則需要生成時設定引數即可.

在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄裡輸入 “-encoding utf-8 -charset utf-8”.


相關推薦

javadoc生成說明文

JDK中可執行命令:javadoc和相關引數如下: C:\Users\123>javadoc javadoc: 錯誤 - 未指定程式包或類。 用法: javadoc [options] [packagenames] [sourcefiles] [@files] -ov

使用javadoc生成專案的幫助文

專案的幫助文件更有利於他人對專案的使用。可以通過cmd命令列和exlipse整合的javadoc功能兩種方式製作幫助文件。cmd命令方式,是使用的是jdk自帶的工具,javadoc。開啟cmd,如果沒有為jdk的bin路徑建立環境變數,不可以在任意路徑使用javadoc命令,

使用eclipse生成javadoc幫助文

方式一: 1.首先,開啟Eclipse,在需要生成Javadoc的專案上右擊滑鼠,在彈出來的列表中點選”Export“選項。 2.在彈出來的”Export“視窗中,選擇匯出的目標,這裡選擇Java

使用javadoc生成api文(一):註釋及標記

註釋及標記 一:常用註釋 //單行註釋; ---->一般用於描述單行的資訊 /** */多行註釋;---->一般使用者描述類或方法 二:嵌入HTML 註釋中嵌入HTML為了使後面生成api更加美觀。在/**與*/中間可以根據HTML語言任意設計api介

Java使用Javadoc生成說明幫助文

寫這篇文章完全是一時興起,因為在此之前,我其實也並沒有使用過 Java Doc 的功能。但是即使很少使用得到,但是你不得不承認,如果公司的API能夠整理出這麼一套API,我想每一個剛入職的員工都會對它愛不釋手的。 程式碼中註釋的使用 1. 首先看一

CSS雪碧圖自動生成

自動生成 position enter 教程 下載地址 com 包含 nbsp round http://www.99css.com/1524/ 包含詳細的下載地址、下載步驟以及使用教程 亮點:自動合成雪碧圖+自動生成雪碧圖background-position代碼CS

jquery二維碼生成jquery.qrcode.js

qrc cti 條碼 客戶端 code www bsp 想要 如何使用 插件描述:jquery.qrcode.js 是一個能夠在客戶端生成矩陣二維碼QRCode 的jquery插件 ,使用它可以很方便的在頁面上生成二維條碼。 轉載於:http://www.jq22.com/

根據EXML文生成聲明代碼

namespace 命名 read adl http ids containe order width 工作中時常需要把EXML代碼中聲明的組件編寫到ts文件中,耗時耗力。因此編寫一個小工具,自動生成組件聲明代碼。 工具代碼如下:1234567891011121314151

前臺自動生成

back ont sum ack nbsp round mar value tro 前臺: <div id="location" runat="server"> </div> 後臺:     /

代碼自動生成

gpo pub tis text close connect tro pass 自動生成 代碼自動生成插件 使用代碼生成插件可以根據數據表及表中的字段,默認使用駝峰映射規則創建。 pojo對象/pojoMapper接口對象/pojoMapper.xml文件/並且其中提供了類

vue.js 二維碼生成

onf 引入 post data png 單位 res 大小 tab 安裝 通過NPM安裝 npm install vue-qart --save 插件應用 將vue-qart引入你的應用 import VueQArt from ‘vue-qart

獲取TypeScript的聲明文.d.ts

http col 安裝包 target 文件 目錄 tps div color 一、TypeScript的聲明文件就像C/C++用.h文件。當使用TypeScript調用其他已經編寫好的類庫時,可以提供IntelliSense智能提示。 二、使用npm指令來獲取.d.ts

TypeScript 之 聲明文的發布

聲明 假設 file extension 1.0 reference and npm pub https://www.tslang.cn/docs/handbook/declaration-files/publishing.html 發布聲明文件到npm,有兩種方式:

TypeScript 之 聲明文的結構

ESS ref lib java nod href 文檔 truct 代碼 https://www.tslang.cn/docs/handbook/declaration-files/library-structures.html 模塊化庫 一些庫只能工作在模塊加載器的環

在eclipse中檢視sources原始碼和JavaDoc幫助文

今天學習Netty的過程中,從官網下載的netty裡面的內容如下: 其中jar資料夾裡面的內容如下: 可以看到每一個具體的jar包就對應有一個sources.jar包,然後所有的幫助文件在javaDoc檔案下面的jar包裡面 那怎麼檢視一個類的原始碼和幫助文件呢??? 當我們在沒有進行相應的配置前,當我

.net core webapi 通過swagger生成說明文

1.通過nuget安裝 Swashbuckle.AspNetCore 2.startup.cs=>ConfigureServices,註冊swagger 3.configure中新增: app.UseSwagger(); app.UseSwaggerUI(c => {   c.Sw

javaDoc和java檔案的註釋以及javadoc生成出現的問題【dos option選項】

參考文章,百度百科                     http://88250.b3log.org/when-the-little-things-count-javadoc                     javadoc的檢視幫助文件:http://docs.

MITK(二): 生成

nag png 設置 dir image follow mark type .exe 簡述 MITK(一)中編譯了MITK軟件,本文在此基礎上生成MITK插件。編譯環境請參考上一篇文章,簡要步驟如下: 使用MitkPluginGenerator.exe 生成插件項目文件(

XtraReport動態生成時的位置問題

win light rep info line clas :poi rom 解決 1.問題:在BeforePrint生成XRLabel時發現用同樣的PointF給LocationF賦值,和在設計界面拖放上的XRLabel位置不同,此時的XtraReport的ReportUn

Android studio中gradle配置打jar包和生成Javadoc

Android studio 中生成Javadoc 使用Android studio提供的生成Javadoc的方法(之前沒有想要使用這種方式的原因是因為當時以為使用這種方式的話每次生成都需要選擇想要生成的java檔案, 過於麻煩), 最後發現, 使用這種方式只有配置過一次規則之後, 這個規則