Введение
Javadoc — это генератор документации, разработанный Sun Microsystems для языка Java (в настоящее время принадлежащий корпорации Oracle) для создания документации API в формате HTML на основе исходного кода Java. Формат HTML используется для удобства организации гиперссылок между связанными документами. Формат "doc comments", используемый Javadoc, является де-факто отраслевым стандартом для документирования классов Java. Некоторые интегрированные среды разработки (IDE), такие как IntelliJ IDEA, NetBeans и Eclipse, автоматически генерируют шаблоны Javadoc. Многие текстовые редакторы помогают пользователям создавать исходный код Javadoc и используют информацию Javadoc в качестве внутренних ссылок для программистов. Javadoc также предоставляет API для создания доклетов и таглетов, позволяя пользователям анализировать структуру Java-приложения. Благодаря этому JDiff может генерировать отчеты об изменениях между двумя версиями API. Javadoc не влияет на производительность Java, так как все комментарии удаляются на этапе компиляции. Написание комментариев и документации Javadoc способствует лучшему пониманию кода и, следовательно, его более эффективной поддержке.
Javadoc is a documentation generator created by Sun Microsystems for the Java language (now owned by Oracle Corporation) for generating API documentation in HTML format from Java source code. The HTML format is used for adding the convenience of being able to hyperlink related documents together. The "doc comments" format used by Javadoc is the de facto industry standard for documenting Java classes. Some IDEs, like IntelliJ IDEA, NetBeans and Eclipse, automatically generate Javadoc templates. Many file editors assist the user in producing Javadoc source and use the Javadoc info as internal references for the programmer. Javadoc also provides an API for creating doclets and taglets, which allows users to analyze the structure of a Java application. This is how JDiff can generate reports of what changed between two versions of an API. Javadoc does not affect performance in Java as all comments are removed at compilation time. Writing comments and Javadoc is for better understanding the code and thus better maintaining it.
История
Javadoc был одним из первых генераторов документации для языка Java. До использования генераторов документации было принято привлекать технических писателей, которые обычно создавали отдельную документацию для программного обеспечения, однако поддерживать эту документацию в актуальном состоянии с самим программным обеспечением было значительно сложнее. Javadoc используется в Java с момента первого релиза и обычно обновляется с каждым новым выпуском Java Development Kit. Синтаксис `@field` в Javadoc был скопирован системами документации для других языков, включая кросс-языковой Doxygen, систему JSDoc для JavaScript и HeaderDoc от Apple.