程序師世界是廣大編程愛好者互助、分享、學習的平台,程序師世界有你更精彩!
首頁
編程語言
C語言|JAVA編程
Python編程
網頁編程
ASP編程|PHP編程
JSP編程
數據庫知識
MYSQL數據庫|SqlServer數據庫
Oracle數據庫|DB2數據庫
 程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> 注釋文檔

注釋文檔

編輯:關於JAVA

對於Java語言,最體貼的一項設計就是它並沒有打算讓人們為了寫程序而寫程序——人們也需要考慮程序的文檔化問題。對於程序的文檔化,最大的問題莫過於對文檔的維護。若文檔與代碼分離,那麼每次改變代碼後都要改變文檔,這無疑會變成相當麻煩的一件事情。

解決的方法看起來似乎很簡單:將代碼同文檔“鏈接”起來。為達到這個目的,最簡單的方法是將所有內容都置於同一個文件。然而,為使一切都整齊劃一,還必須使用一種特殊的注釋語法,以便標記出特殊的文檔;另外還需要一個工具,用於提取這些注釋,並按有價值的形式將其展現出來。這些都是Java必須做到的。

用於提取注釋的工具叫作javadoc。它采用了部分來自Java編譯器的技術,查找我們置入程序的特殊注釋標記。它不僅提取由這些標記指示的信息,也將毗鄰注釋的類名或方法名提取出來。這樣一來,我們就可用最輕的工作量,生成十分專業的程序文檔。

javadoc輸出的是一個HTML文件,可用自己的Web浏覽器查看。該工具允許我們創建和管理單個源文件,並生動生成有用的文檔。由於有了jvadoc,所以我們能夠用標准的方法創建文檔。而且由於它非常方便,所以我們能輕松獲得所有Java庫的文檔。

  1. 上一頁:
  2. 下一頁:
Copyright © 程式師世界 All Rights Reserved