Кіріспе
Java үшін құжаттама генераторы Javadoc – Java тілі үшін (қазір Oracle корпорациясына тиесілі) Sun Microsystems компаниясы жасаған, Java бастапқы кодынан HTML форматында API құжаттамасын жасауға арналған құжаттама генераторы. HTML форматы байланысты құжаттарды бір-бірімен гиперсілтемелеудің қолайлылығын қамтамасыз ету үшін қолданылады. Javadoc қолданатын "doc comments" форматы Java сыныптарын құжаттау үшін де-факто индустрия стандарты болып табылады. IntelliJ IDEA, NetBeans және Eclipse сияқты кейбір IDE-лер Javadoc үлгілерін автоматты түрде жасайды. Көптеген файл редакторлары Javadoc бастапқы кодын жасауға көмектеседі және Javadoc ақпаратын бағдарламашы үшін ішкі сілтемелер ретінде пайдаланады. Javadoc сонымен қатар Java қосымшасының құрылымын талдауға мүмкіндік беретін doclets және taglets жасауға арналған API ұсынады. Осылайша 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-тің әрбір жаңа нұсқасымен жаңартылады. Javadoc-тың @field синтаксисі басқа тілдердегі құжаттама жүйелерінде де қолданылды, мысалы, Doxygen, JavaScript үшін JSDoc және Apple-дің HeaderDoc.