.jd文件的用途是什么？

Question

我一直在.jd文件的工作在我的工作，建立它在我的本地计算机将其转换为HTML ...

不过，我仍然感到困惑的是什么.jd文件是？我做了一些研究，定义如下：“Javadoc是一个从Javadoc注释中生成html文档（类似于java.sun.com的参考页面）的工具。”

当我看着.jd文件代码，它们看起来非常像html。他们有<p>标签和<li>标签。程序员编写javadoc代码吗？或者Javadoc是一个工具（对我来说非常模糊，一个名为Javadoc的软件工具来生成.jd文件？）从Java代码中提取评论？

有人可以帮助我理解它？由于我不是直接处理生成.jd文件，所以很难理解它的使用，究竟是什么...

非常感谢！

Answer 1

一个javadoc是将类，方法，和其他文档注释Java代码中为可读的HTML API文档格式，供人看的方法。

几乎所有的Java内部具体的类和方法的文档是从Javadoc文件形成。

TL; DR：它们将注释转换为文档页面。

Answer 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（见例）