導航:首頁 > 編程語言 > java注釋生成doc

java注釋生成doc

發布時間:2024-04-06 14:11:35

java中如何自動生成注釋

你說的應該是生成javadoc吧?

最簡單方式就是使用命令行, cd到你的項目源代碼目錄下, 輸入如下指令:

javadoc-ddocs-subpackagescom.yourpackage

其中-d docs指定了生成的javadoc在相對目錄docs下, -subpackages com.yourpackage指定了你要被生成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>指定查找用戶類文件的位置
-cp<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的全限定名稱
-tagletpathTaglet的路徑
-charset<charset>用於跨平台查看生成的文檔的字元集。
-helpfile<file>包含幫助鏈接所鏈接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每個製表符占據的空格數
-keywords使程序包,類和成員信息附帶HTML元標記
-stylesheetfile<path>用於更改生成文檔的樣式的文件
-docencoding<name>指定輸出的字元編碼

Ⅱ java編程題目!提取java源代碼中的注釋生成javadoc或txt文件

用javadoc命令

格式如下
javadoc [options] [packagenames] [sourcefile] [@files]

ptions
命令行選項,如本文檔中所指定。要了解 javadoc 選項的典型用法,參見實際示例。

packagenames
一系列包的名字,用空格分隔,例如 java.lang java.lang.reflect java.awt。必須分別指定想要為之建立文檔的每一個包。Javadoc 不遞歸地作用於子包。不允許使用通配符,如(*)。參見示例 - 建立包的文檔

sourcefiles
一系列源文件名,用空格分隔。源文件名可包括路徑和通配符如(*)。例如:Button.java /home/src/java/awt/Graphics*.java 參見示例 - 建立類的文件。還可混合包名和源文件,如 示例 - 建立包和類的文檔 中所示。

@files
以任何次序包含包名和源文件的一個或多個文件。

這樣就可以生成程序文檔資料了
不知道你要的是不是這個?

Ⅲ Java中的 /**......*/ 什麼作用,怎麼用

這是注釋,你在寫代碼的時候,你如果使用這種注釋,你使用javadoc命令,就會把注釋回的內容生成文答檔了,知道java的doc幫助文檔嗎?就是這么生成的
我給你舉個例子
你去寫這么一個類,記住,要這個類是public
/**
這是是javadoc,這是一個幫助
*/
public class Test
{
public static void main(String []args)
{
System.out.print("java");
}
}

然後你編譯的時候,輸入javadoc Test.java
接著就會生成一個網頁,打開你就懂了

閱讀全文

與java注釋生成doc相關的資料

熱點內容
車載地圖打開沒有配置文件 瀏覽:858
5g和數據碼哪個重要 瀏覽:641
藍牙配對成功後如何傳送文件 瀏覽:300
什麼是窗口數據 瀏覽:382
哪個讀書app好一些 瀏覽:527
iOS14屏蔽更新配置文件 瀏覽:792
javafx做界面案例 瀏覽:775
excel如何轉dbase文件 瀏覽:702
手機3d文件打開 瀏覽:225
無印良品書包在哪個APP買 瀏覽:140
大數據建模服務模型 瀏覽:841
復活老照片是什麼app 瀏覽:943
進電商哪些數據分析軟體是免費的 瀏覽:61
oracle做資料庫的程序源碼 瀏覽:201
汽車復合中心編程用什麼軟體好 瀏覽:955
蘋果xr小組件如何添加app 瀏覽:413
mvc配置文件詳解 瀏覽:655
維盟密碼怎麼設置圖解 瀏覽:779
末日類單機游戲安卓 瀏覽:809
ps的修補工具在哪裡 瀏覽:670

友情鏈接