亚洲香蕉成人av网站在线观看_欧美精品成人91久久久久久久_久久久久久久久久久亚洲_热久久视久久精品18亚洲精品_国产精自产拍久久久久久_亚洲色图国产精品_91精品国产网站_中文字幕欧美日韩精品_国产精品久久久久久亚洲调教_国产精品久久一区_性夜试看影院91社区_97在线观看视频国产_68精品久久久久久欧美_欧美精品在线观看_国产精品一区二区久久精品_欧美老女人bb

首頁 > 學院 > 開發設計 > 正文

JavaDoc,在 Java 的注釋上做文章(上)

2019-11-18 13:28:50
字體:
來源:轉載
供稿:網友

  對于java注釋我們主要了解兩種:
  // 注釋一行
  /* ...... */ 注釋若干行
  但還有第三種,文檔注釋:
  /** ...... */ 注釋若干行,并寫入 javadoc 文檔
  通常這種注釋的多行寫法如下:
  /**
  * .........
  * .........
  */
  很多人多忽視了這第三種注釋,那么這第三種注釋有什么用?javadoc 又是什么東西?下面我們就談談。
  一. Java 文檔和 Javadoc
  Java 程序員都應該知道使用 JDK 開發,最好的幫助信息就來自 SUN 發布的 Java 文檔。它分包、分類具體的提供了各方法、屬性的幫助信息,具有具體的類樹信息、索引信息等,并提供了許多相關類之間的關系,如繼續、實現接口、引用等。
  Java 文檔全是由一些 Html 文件組織起來的,在 SUM 的站點上可以下載它們的壓縮包。但是你肯定想不到,這些文檔我們可以自己生成?!痛舜蜃?,再吊一次胃口。
  安裝了 JDK 之后,安裝目錄下有一個 src.jar 文件或者 src.zip 文件,它們都是以 ZIP 格式壓縮的,可以使用 WinZip 解壓。解壓之后,我們就可以看到分目錄放的全是 .java 文件。是了,這些就是 Java 運行類的源碼了,非常完整,連注釋都寫得一清二楚……不過,怎么看這些注釋都有點似曾相識的感覺?
  這就不希奇了,我們的迷底也快要揭開了。假如你仔細對比一下 .java 源文件中的文檔注釋 (/** ... */) 和 Java 文檔的內容,你會發現它們就是一樣的。Java 文檔只是還在格式和排版上下了些功夫。再仔細一點,你會發現 .java 源文件中的注釋還帶有 HTML 標識,如 <B>、
、<Code> 等,在 Java 文檔中,該出現這些標識的地方,已經按標識的的定義進行了排版。
  終于真像大白了,原來 Java 文檔是來自這些注釋。難怪這些注釋叫做文檔注釋呢!不過,是什么工具把這些注釋變成文檔的呢?
  是該請出 javadoc 的時候了。在 JDK 的 bin 目錄下你可以找到 javadoc,假如是 Windows 下的 JDK,它的文件名為 javadoc.exe。使用 javdoc 編譯 .java 源文件時,它會讀出 .java 源文件中的文檔注釋,并按照一定的規則與 Java 源程序一起進行編譯,生成文檔。
  介紹 javadoc 的編譯命令之前,還是先了解一下文檔注釋的格式吧。不過為了能夠編譯下面提到的若干例子,這里先介紹一條 javadoc 命令:
  javadoc -d 文檔存放目錄 -author -version 源文件名.java
  這條命令編譯一個名為 “源文件名.java”的 java 源文件,并將生成的文檔存放在“文檔存放目錄”指定的目錄下,生成的文檔中 index.html 就是文檔的首頁。-author 和 -version 兩上選項可以省略。
  二. 文檔注釋的格式
  文檔注釋可以用于對類、屬性、方法等進行說明。寫文檔注釋時除了需要使用 /** .... */ 限定之外,還需要注重注釋內部的一些細節問題。
  1. 文檔和文檔注釋的格式化
  生成的文檔是 HTML 格式,而這些 HTML 格式的標識符并不是 javadoc 加的,而是我們在寫注釋的時候寫上去的。比如,需要換行時,不是敲入一個回車符,而是寫入
,假如要分段,就應該在段前寫入 <p>。
  因此,格式化文檔,就是在文檔注釋中添加相應的 HTML 標識。
  文檔注釋的正文并不是直接復制到輸出文件 (文檔的 HTML 文件),而是讀取每一行后,刪掉前導的 * 號及 * 號以前的空格,再輸入到文檔的。如
  /**
  * This is first line.

  ***** This is second line.

  This is third line.
  */ 
  編譯輸出后的 HTML 源碼則是
  This is first line.

  This is second line.

  This is third line. 
  前導的 * 號答應連續使用多個,其效果和使用一個 * 號一樣,但多個 * 號前不能有其它字符分隔,否則分隔符及后面的 * 號都將作為文檔的內容。* 號在這里是作為左邊界使用,如上例的第一行和第二行;假如沒有前導的 * 號,則邊界從第一個有效字符開始,而不包括前面的空格,如上例第三行。
  還有一點需要說明,文檔注釋只說明緊接其后的類、屬性或者方法。如下例:
  /** comment for class */
  public class Test {
  /** comment for a attribute */
  int number;
  /** comment for a method */
  public void myMethod() { ...... }
  ......
  }
  上例中的三處注釋就是分別對類、屬性和方法的文檔注釋。它們生成的文檔分別是說明緊接其后的類、屬性、方法的?!熬o接”二字尤其重要,假如忽略了這一點,就很可能造成生成的文檔錯誤。如
  import java.lang.*;
  /** commnet for class */
  public class Test { ...... }
  // 此例為正確的例子
  這個文檔注釋將生成正確的文檔。但只需要改變其中兩行的位置,變成下例,就會出錯:
  /** commnet for class */
  import java.lang.*;
  public class Test { ...... }
  // 此例為錯誤的例子
  這個例子只把上例的 import 語句和文檔注釋部分交換了位置,結果卻大不相同——生成的文檔中根本就找不到上述注釋的內容了。原因何在?
  “/** commnet for class */”是對 class Test 的說明,把它放在“public class Test { ...... }”之前時,其后緊接著 class Test,符合規則,所以生成的文檔正確。但是把它和“import java.lang.*;”調換了位置后,其后緊接的就是不 class Test 了,而是一個 import 語句。由于文檔注釋只能說明類、屬性和方法,import 語句不在此列,所以這個文檔注釋就被當作錯誤說明省略掉了。
  2. 文檔注釋的三部分
  根據在文檔中顯示的效果,文檔注釋分為三部分。先舉例如下,以便說明。
  /**
  * show 方法的簡述.
  * <p>

發表評論 共有條評論
用戶名: 密碼:
驗證碼: 匿名發表
亚洲香蕉成人av网站在线观看_欧美精品成人91久久久久久久_久久久久久久久久久亚洲_热久久视久久精品18亚洲精品_国产精自产拍久久久久久_亚洲色图国产精品_91精品国产网站_中文字幕欧美日韩精品_国产精品久久久久久亚洲调教_国产精品久久一区_性夜试看影院91社区_97在线观看视频国产_68精品久久久久久欧美_欧美精品在线观看_国产精品一区二区久久精品_欧美老女人bb
亚洲激情视频在线| 久久久久久久香蕉网| 亚洲欧美在线一区二区| 欧美有码在线观看视频| 亚洲男人天堂古典| 日韩最新在线视频| 久久久国产一区二区| 26uuu国产精品视频| 久热在线中文字幕色999舞| 亚洲乱亚洲乱妇无码| 久久久国产精品亚洲一区| 91精品啪aⅴ在线观看国产| 亚洲成人黄色网址| 欧美日韩性视频| 精品丝袜一区二区三区| 中文字幕亚洲一区在线观看| 91av视频在线播放| 免费不卡欧美自拍视频| 国产一区欧美二区三区| 国产精品www色诱视频| 欧美日韩国产影院| 国产精品成熟老女人| 亚洲欧洲自拍偷拍| 国产成人在线一区| 91免费精品国偷自产在线| 欧美噜噜久久久xxx| 亚洲国产欧美在线成人app| 亚洲九九九在线观看| 欧美小视频在线| 国产精品电影一区| 欧美激情中文网| 亚洲女人天堂av| 日韩网站免费观看高清| 亚洲性夜色噜噜噜7777| 日韩av在线不卡| 欧美激情网友自拍| 国产69久久精品成人看| 国产福利视频一区二区| 亚洲欧美一区二区精品久久久| 日韩电影第一页| 欧美日韩国产123| 久久久久久久久久亚洲| 国产a∨精品一区二区三区不卡| 亚洲天堂一区二区三区| 国产精品v日韩精品| 成人情趣片在线观看免费| 欧美激情一区二区三区高清视频| 国产精品亚洲欧美导航| 国产午夜精品理论片a级探花| 欧美日韩国产色| 国产成人亚洲综合| 国产成人精品视频| 亚洲字幕在线观看| 岛国av一区二区在线在线观看| www.日本久久久久com.| 91禁外国网站| 在线日韩中文字幕| 国产精品网站大全| 精品久久久久久久久中文字幕| 国产成人高潮免费观看精品| 久久久国产成人精品| 久久久久久久久电影| 高清在线视频日韩欧美| 国产精品入口尤物| 欧美电影第一页| 日韩欧美国产网站| 中文字幕日韩有码| 欧美成人全部免费| 色播久久人人爽人人爽人人片视av| 精品国产91乱高清在线观看| 成人激情视频小说免费下载| 亚洲国产第一页| 久久久人成影片一区二区三区观看| 国产成人91久久精品| 亚洲有声小说3d| 国产精品久久久久免费a∨大胸| 久久五月情影视| 成人性生交大片免费看视频直播| 亚洲国产另类久久精品| 日韩一级黄色av| 色老头一区二区三区在线观看| 在线日韩欧美视频| 久久久久久久久爱| 亚洲а∨天堂久久精品喷水| 91精品国产高清久久久久久久久| 欧美精品videos性欧美| 日韩在线资源网| 狠狠躁18三区二区一区| 亚洲精品视频播放| 自拍亚洲一区欧美另类| 成人久久18免费网站图片| 久热精品视频在线免费观看| 欧美成人免费视频| 久久久黄色av| 国产精品偷伦视频免费观看国产| 欧美美女15p| 久久久亚洲国产| 国产美女精品免费电影| 欧美人交a欧美精品| 国产精品丝袜高跟| 亚洲欧美中文字幕在线一区| 亚洲国产日韩一区| 日韩在线激情视频| 欧美午夜美女看片| 亚洲日韩中文字幕在线播放| 最新亚洲国产精品| 97**国产露脸精品国产| 亚洲精品视频播放| 日本精品久久久久久久| 亚洲最大福利视频| 亚洲免费小视频| 欧美极品少妇全裸体| 欧美午夜女人视频在线| 久久亚洲欧美日韩精品专区| 亚洲美女黄色片| 久久久av一区| 国产精品扒开腿爽爽爽视频| 日韩国产激情在线| 精品久久久久久亚洲国产300| 精品在线欧美视频| 亚洲欧洲xxxx| 亚洲最大福利视频网站| 欧美日韩综合视频| 中文字幕日韩视频| 欧美中文在线字幕| 亚洲激情在线观看| 91精品国产高清自在线| 日韩免费在线播放| 欧美福利视频在线观看| 91色视频在线导航| 亚洲自拍另类欧美丝袜| 欧美美最猛性xxxxxx| 97精品久久久中文字幕免费| 91色视频在线观看| 国产精品大陆在线观看| 国产精品欧美久久久| 国产精品久久久久影院日本| 欧美极品少妇全裸体| 欧美日韩精品在线播放| 九九综合九九综合| 尤物九九久久国产精品的分类| 91av中文字幕| 亚洲午夜激情免费视频| 国产精品视频xxx| 欧美日本黄视频| 综合网中文字幕| 欧美激情免费视频| 国产伦精品一区二区三区精品视频| 97在线观看视频| 欧美另类69精品久久久久9999| 亚洲大胆人体av| 久久精品国产久精国产一老狼| 91av视频在线观看| 日韩电影免费观看中文字幕| 亚洲二区中文字幕| 日韩精品视频观看| 永久555www成人免费| 日韩美女av在线| 日韩成人av一区| 中文字幕日韩欧美在线视频| 亚洲精选中文字幕| 色999日韩欧美国产| 久久久久久欧美| 国产91精品网站|