A. 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>指定輸出的字元編碼
B. 怎麼生成java注釋文檔
在要生成文檔的項目上右鍵 export -->other-->javadoc,然後根據提示設置就行了
C. Java如何進行單行注釋和多行注釋
(1)單行注釋:以「 // 」開頭後面接所要加的說明的內容。如下面所示: //定義變數a int a = 10; //定義變數b int b = 20;上面的語句中,在編譯的過程就會直接略過注釋,只會編譯 int a = 10 和 int b = 20這兩句。由此可見注釋只是起著說明的作用。
(2)多行注釋:以「/*」開頭,以「*/」結尾。 假設當你要說明你所寫的代碼的功能時。要說明的內容有很多。如果全部放在同一行會顯得很難看。所以一般會用多行來寫,如下所示// 說明//說明//說明//說明以上是用四個單行注釋來注釋四行說明。但如果有10行說明就要按十個「//」這顯示很麻煩,所以這時就可採用多行注釋。上面的可改成:/*說明說明說明說明*/也可以這樣/* 說明 說明 說明 說明 */
(3)文檔注釋:以「/**」開頭,以「*/」結尾。文檔注釋主要是生成文檔的。
D. 什麼是注釋如何在Java程序中加入注釋
試想一下,一個沒有一句注釋的程序源碼,怎麼讀,一個程序要上萬條代碼不可能全部記得住哪一塊是什麼用,而且一個項目也不會是一個人獨自完成,那樣效率太低,多人合作就要給別人說明,每一塊是什麼用,方便他人使用,方便自己更正,而這些說明文字就是注釋,注釋不會被執行,不影響運行結果。
Java中代碼的注釋有三種:
// 注釋一行
/* ...... */ 注釋若干行
/** ...... */ 注釋若干行,並寫入 javadoc 文檔
前兩種比較容易理解,至於第三種,你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。
注釋就是對代碼的解釋和說明,其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時,寫程序的人給一個語句、程序段、函數等的解釋或提示,能提高程序代碼的可讀性。
E. 如何寫Java文檔注釋
/**
* @author
* @param name
* @
*/
表示的是文檔注釋,文檔注釋里可以以作者名,參數的意義,版本等等。對於方法的文檔注釋,可以在方法的上面輸入「/**」按回車,就會出來了
F. 如何使用javadoc命令生成api文檔,文檔注釋
使用javadoc命令生成api文檔:
創建java源文件包。java文件都是存放在一個package包中,這樣方便對java文件進行操作和區分,首先在磁碟上創建文件夾一樣的方式創建package包。
創建java源文件。在包下,創建與文件名相同的java源文件,輸入一些文檔注釋,這些文檔注釋用於自動的api文件進行說明使用。
進入java源文件目錄。通過cd等windows命令進入java源文件包所在的磁碟位置。
查看javadoc命令使用說明。如果是第一次使用javadoc命令,可以通過javadoc -help命令查看javadoc使用說明。
開始創建api文件。使用命令輸入javadoc -d javaapi -header 測試的API -doctitle 這是我的第一個文檔注釋 -version -author javadoc/Hello.java 進行文檔生成。-d:文件存儲位置; -head:文件頭部名稱; -version:顯示版本; -author:顯示作者; javadoc/Hello.java 處理的文件包以及java源文件。
查看生成的api文件。創建成功之後,就會自動創建指定的文件夾下生成api文件。打開index.html就是api文件的入口。
G. 如何寫Java文檔注釋
如何寫Java文檔注釋(Java Doc Comments)
本文翻譯自How to Write Doc Comments for the Javadoc Tool,但是精簡了一些私以為不重要的東西
本文不討論如何使用javadoc工具自動生成文檔的方法,而是主要探討應該如何去寫文檔注釋
業余時間整理,難免有遺漏或錯誤,如有發現歡迎指正
轉載地址:網頁鏈接
文檔注釋概覽
「文檔注釋」(Java Doc Comments)是專門為了用javadoc工具自動生成文檔而寫的注釋,它是一種帶有特殊功能的注釋。
文檔注釋與一般注釋的最大區別在於起始符號是/**而不是/*或//。
比如:
/**這是文檔注釋*/
/* 這是一般注釋*/
// 這是一般注釋
在一些IDE(比如Eclipse)中,文檔注釋會以不同於普通注釋的顏色高亮顯示。
此外,文檔注釋只負責描述類(class)、介面(interface)、方法(method)、構造器(constructor)、成員欄位(field)。相應地,文檔注釋必須寫在類、介面、方法、構造器、成員欄位前面,而寫在其他位置,比如函數內部,是無效的文檔注釋。
文檔注釋採用HTML語法規則書寫,支持HTML標記(tag),同時也有一些額外的輔助標記。需要注意的是,這些標記不是給人看的(通常他們的可讀性也不好),他們的作用是為了javadoc工具更好地生成最終文檔。所以,雖然有些標記寫起來麻煩且看著不直觀,還是要老老實實按規矩寫滴。
原文地址:網頁鏈接