2015-12-07 190 views
2

我一直在.jd文件的工作在我的工作,建立它在我的本地計算機將其轉換爲HTML ...

.jd文件的用途是什麼?

不過,我仍然感到困惑的是什麼.jd文件是?我做了一些研究,定義如下:「Javadoc是一個從Javadoc註釋中生成html文檔(類似於java.sun.com的參考頁面)的工具。」

當我看着.jd文件代碼,它們看起來非常像html。他們有<p>標籤和<li>標籤。程序員編寫javadoc代碼嗎?或者Javadoc是一個工具(對我來說非常模糊,一個名爲Javadoc的軟件工具來生成.jd文件?)從Java代碼中提取評論?

有人可以幫助我理解它?由於我不是直接處理生成.jd文件,所以很難理解它的使用,究竟是什麼...

非常感謝!

+0

這是非常罕見的真正看到一個'.jd'文件。 Javadoc通常包含在代碼中,然後處理成普通的'.html'。 – chrylis

+0

這就是我對Javadoc感到困惑......你說的是Javadoc包含在代碼中。讓我們說代碼是Java代碼,那麼你的意思是說javadoc只是Java代碼中的註釋?如果是這樣的話,那麼應該有一個工具來提取所有的註釋(如你所說的,javadoc)來提取它們並使它們成爲一個.jd文件,對嗎? – Penny

+0

不,它使他們成爲一個HTML文件。你真的在任何地方看到過一個'.jd'文件嗎? – chrylis

回答

1

一個javadoc是將類,方法,和其他文檔註釋Java代碼中爲可讀的HTML API文檔格式,供人看的方法。

幾乎所有的Java內部具體的類和方法的文檔是從Javadoc文件形成。

TL; DR:它們將註釋轉換爲文檔頁面。

2

JavaDoc是由開發人員在其源代碼中嵌入註釋而編寫的。

所以,例如:

/** 
* Returns an Image object that can then be painted on the screen. 
* The url argument must specify an absolute {@link URL}. The name 
* argument is a specifier that is relative to the url argument. 
* <p> 
* This method always returns immediately, whether or not the 
* image exists. When this applet attempts to draw the image on 
* the screen, the data will be loaded. The graphics primitives 
* that draw the image will incrementally paint on the screen. 
* 
* @param url an absolute URL giving the base location of the image 
* @param name the location of the image, relative to the url argument 
* @return  the image at the specified URL 
* @see   Image 
*/ 
public Image getImage(URL url, String name) { 
     try { 
      return getImage(new URL(url, name)); 
     } catch (MalformedURLException e) { 
      return null; 
     } 
} 

該實施例是記錄了一個名爲的getImage方法。

JavaDoc的是偉大的,因爲它是開發人員可以編寫AS-他們碼,右沿着他們的代碼,並通過發電機運行後,他們有其他人可以輕鬆閱讀很好的技術文檔資料。

您看到HTML在.jd文件的原因是格式化的原因,一些HTML可以嵌入在JavaDoc(見例)

+0

謝謝!但是我看到的.jd文件沒有任何評論,只是'頁面。title = blahblahblah'在第二行,'@jd:body'在第二行,那麼下面幾乎所有的html代碼都帶有幾個像'{@docRoot}'這樣的標籤實例。這是爲什麼?另外,根據你的解釋,我猜你上面提供的javaDoc例子中的註釋在從jd文件轉換而來的html中(或者可能不是,因爲它取決於html文件的用途)而不註釋? – Penny

+0

@我所描述的是典型的JavaDoc用法。 .jd文件可能是貴公司使用的內部格式? –

+0

我在這裏看不到.jd文件:http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html –