Javadoc (первоначально JavaDoc ) [1] — это генератор документации, созданный Sun Microsystems для языка Java (теперь принадлежащего Oracle Corporation ) для генерации документации API в формате HTML из исходного кода Java . Формат HTML используется для добавления удобства, заключающегося в возможности связывать связанные документы по гиперссылкам . [2]
Формат «комментариев к документам» [3] , используемый Javadoc, является отраслевым стандартом де-факто для документирования классов Java. Некоторые IDE , [4] такие как IntelliJ IDEA , NetBeans и Eclipse , автоматически генерируют Javadoc HTML. Многие редакторы файлов помогают пользователю в создании исходного кода Javadoc и используют информацию Javadoc в качестве внутренних ссылок для программиста.
Javadoc также предоставляет API для создания доклетов и таглетов, что позволяет пользователям анализировать структуру приложения Java. Вот как JDiff может генерировать отчеты о том, что изменилось между двумя версиями API.
Javadoc не влияет на производительность в Java, так как все комментарии удаляются во время компиляции. Написание комментариев и Javadoc необходимо для лучшего понимания кода и, следовательно, для его лучшего обслуживания.
Javadoc был ранним генератором документации по языку Java . [5] До использования генераторов документации было принято использовать технических писателей, которые обычно писали только отдельную документацию для программного обеспечения, [6] но было намного сложнее синхронизировать эту документацию с самим программным обеспечением.
Javadoc используется Java с момента первого выпуска и обычно обновляется при каждом новом выпуске Java Development Kit .