Question

我一直在工作中使用.jd文件，在我的本地计算机上构建它以将其转换为HTML ...

但是，我仍然对.jd文件的用途感到困惑？我做了一些研究，定义是：“Javadoc是一个工具，可以从代码中的Javadoc注释生成html文档（类似于java.sun.com上的参考页面）。”

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

有人可以帮我理解吗？由于我不是直接生成.jd文件，因此很难理解它的用途以及它究竟是什么......

非常感谢！

Answer 1

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非常棒，因为它的开发人员可以将代码编写为代码，并且在运行生成器后，他们拥有其他人可以轻松阅读的精美技术文档。

你在.jd文件中看到html的原因是出于格式化的原因，一些html可以嵌入到JavaDoc中（参见示例）

Answer 2

Javadoc是一种将Java代码中的类，方法和其他文档注释转换为可读的HTML API文档格式的方法，供人们查看。

几乎所有关于Java中特定类和方法的文档都是由Javadoc文件构成的。

TL; DR：他们将评论转换为文档页面。

用于什么.jd文件到底是什么？

2 个答案: