單行注釋、多行注釋與文檔注釋


單行注釋:// 注釋內容

多行注釋:/* 注釋內容*/

文檔注釋:/** 注釋內容 */ (它是java語言特有的注釋,其中的注釋內容可以被JDK提供的工具 javadoc 所解析,生成一套能夠以網頁形式體現程序的說明文檔)

區別:多行注釋不可以生成開發者文檔,而文檔注釋可以生成開發者文檔(文檔分為使用者文檔和開發者文檔)。

注意規范點:

1、三種注釋都可以出現在程序的任何地方,但是一般要有個規范的地方,不推介任意找位置。

2、單行注釋一般寫在語句的后面。

3、多行注釋和文檔注釋一般寫在語句的上面,文檔注釋只能出現在類、屬性、方法的上面,否則提取不到。

4、多行注釋中可以嵌套單行注釋,多行注釋中不能嵌套多行注釋。

文檔注釋的使用(如果一個類想要使用javadoc工具生成開發者文檔,那么這個類必須使用public修飾):

在已經成功安裝jdk並已經配置好path環境變量的前提下

1、使用dos命令

使用 javadoc 開發工具生成,在命令行下輸入javadoc會有一些javadoc使用說明可以看到。我們使用javadoc -d命令,使用格式:javadoc -d 存放路徑 java源文件

2、eclipse

使用eclipse就沒有這么些問題了,直接創建java類,然后Project-->Generate Javadoc,點擊Generate Javadoc后,進入彈出的界面,選擇javadoc.exe命令的位置,選擇要生成Javadoc的包,或者包下的類,以及生成的Javadoc文檔所存的路徑,默認生成到當前工程目錄下。之后會生成Javadoc文件:在生成文檔的目錄下會有一堆文件,找到index.html文件,打開查看具體的內容就ok


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM