Javadoc (original) (raw)
Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt. Javadoc wurde ebenso wie Java von Sun Microsystems entwickelt und ist ab Version 2 ein Bestandteil des Java Development Kits. Die Dokumentation kann durch spezielle Kommentare im Quelltext angereichert werden, hierbei kommen Tags zum Einsatz, die dazu dienen, z. B. Interfaces, Klassen, Methoden und Felder näher zu beschreiben. Neben der Standardausgabe in HTML sind alternative Ausgaben durch spezielle Doclets möglich. Dies ist eine einfache Form des Literate programming.
| Property | Value |
|---|---|
| dbo:abstract | javadoc je softwarová pomůcka (utilita) firmy Sun Microsystems™ pro automatické generování dokumentace k programu. Jedná se o co do velikosti malou konzolovou aplikaci, která umí procházet zdrojový kód programů v jazyku Java™, vyhledávat speciálně uvozené komentáře a ty posílat na výstup současně generovaného HTML souboru.Pro některé softwarového vývojáře je představa, že po dokončení určité verze svého projektu, budou muset ještě trávit několik hodin vypracováváním dokumentace, nepříjemná – musí totiž znovu procházet veškeré zdrojové kódy, popisovat každou funkci, konstantu nebo třídu, snažit se o jednotný vzhled, atd. Pokud používají javadoc a dodržují alespoň základní komentování ve svých zdrojových kódech, mohou přímo z nich dokumentaci vygenerovat okamžitě bez jakékoli práce navíc. Javadoc podporuje generovat dokumentaci v HTML rámcích i bez nich, jeho poslední verze podporují kaskádové styly. Při jakékoli změně ve zdrojových kódech je možno dokumentaci znovu vygenerovat bez obtížného hledání a zjišťování změn a úpravě v dokumentaci. Výsledné výstupy javadocu jsou poměrně přehledné a většinou své účely postačují. Javadoc umí poznat, který komentář má do dokumentace zahrnout, stejně jako umí identifikovat syntaktický prvek jazyka, k němuž má komentář, který mu předchází, připojit. Komentáře jsou v jazyku Java stejné jako v jazyku C++. Víceřádkové komentáře, které má javadoc identifikovat, začínají znaky /** a končí znaky */. Kromě toho je možno javadocu předávat informace pomocí rezervovaných slov, začínající znakem @. Javadoc je často součástí integrovaného prostředí, které jej umí spouštět (vybráním z roletového menu). Javadoc má mnoho přepínačů, pomocí nichž je možno nakonfigurovat si jeho výstup. (cs) Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt. Javadoc wurde ebenso wie Java von Sun Microsystems entwickelt und ist ab Version 2 ein Bestandteil des Java Development Kits. Die Dokumentation kann durch spezielle Kommentare im Quelltext angereichert werden, hierbei kommen Tags zum Einsatz, die dazu dienen, z. B. Interfaces, Klassen, Methoden und Felder näher zu beschreiben. Neben der Standardausgabe in HTML sind alternative Ausgaben durch spezielle Doclets möglich. Dies ist eine einfache Form des Literate programming. (de) Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente. Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API. (es) Javadoc (originally cased 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 HTML. 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. (en) Javadoc est un outil développé par Oracle, permettant de créer une documentation d'API en format HTML depuis les commentaires présents dans un code source en Java. Conçu à l'origine par Sun MicroSystems (avant son rachat par Oracle), javadoc est le standard industriel pour la documentation des classes Java. La plupart des IDE génèrent automatiquement la javadoc au format HTML. (fr) Javadocとは、サン・マイクロシステムズが開発したコンピュータソフトで、JavaのソースコードからHTML形式のAPI仕様書を生成するものである。 JavadocはJavaクラスの仕様書の標準の書式であり、多くのIDEは自動的にJavadoc HTMLを生成する機能を備えている。 なお、HTML形式は標準の書式であり、カスタマイズにより変更可能である。 (ja) Javadoc è un applicativo incluso nel Java Development Kit della Sun Microsystems, utilizzato per la generazione automatica della documentazione del codice sorgente scritto in linguaggio Java. (it) Javadoc is een documentatiegenerator uit de Java Development Kit (JDK), waarmee HTML-pagina's met API-documentatie worden gemaakt. API documentatie wordt gebruikt om een programma te beschrijven, het geeft aan in welke packages en klassen een Java programma is ingedeeld, welke variabelen en methoden er zijn, en wat ze precies doen in het programma. Javadoc is de industriestandaard voor het documenteren van Java programma's, en de meeste Integrated Development Environments (IDE) zullen automatisch javadoc documentatie genereren. Programmeurs kunnen met bepaalde commentaartekens en Javadoc-elementen onderdelen uitgebreider beschrijven en extra verwijzingen laten genereren door javadoc: Een voorbeeld van het gebruik: /*** Geeft de naam van de persoon* @author John Doe* @param id Identificatienummer van persoon* @return Naam van de gevonden persoon* @since 01-01-2000* @version 1.0* @exception PersonNotFoundException Wanneer er geen persoon met de gegeven identifier kan worden gevonden*/String getName(int id) throws PersonNotFoundException{ ...} (nl) Javadoc é um gerador de documentação criado pela Sun Microsystems para documentar a API dos programas em Java, a partir do código-fonte. O resultado é expresso em HTML. É constituído, basicamente, por algumas marcações muitos simples inseridas nos comentários do programa. Este sistema é o padrão de documentação de classes em Java, e muitas dos IDEs desta linguagem irão automaticamente gerar um Javadoc em HTML. Ele também provê uma API para a criação de e , que permitem a análise da estrutura de um aplicativo Java. É assim, por exemplo, que o consegue gerar relatórios de alterações feitas entre duas versões de uma API. (pt) Javadoc – narzędzie automatycznie generujące dokumentację na podstawie zamieszczonych w kodzie źródłowym znaczników w komentarzach. Javadoc został stworzony specjalnie na potrzeby języka programowania Java przez firmę Sun Microsystems. Wiele nowoczesnych IDE wspomaga tworzenie dokumentacji i pozwala na automatyczne jej generowanie. Umożliwiają one również wykorzystanie takiej dokumentacji jako pomoc dla programisty podczas pisania kodu. (pl) Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc. Javadoc также предоставляет API для создания доклетов и , которые позволяют программисту анализировать структуру Java-приложения. (ru) Javadoc är ett verktyg som utvecklats av Sun Microsystems för att på ett standardiserat sätt skapa dokumentation till javaprojekt. Javadoc genererar dokumentation i HTML-format utifrån kommentarer i källkoden som följer en speciell syntax. Denna programmeringsrelaterade artikel saknar väsentlig information. Du kan hjälpa till genom att lägga till den. (sv) Javadoc（最初是JavaDoc）是由Sun Microsystems为Java语言（现在由甲骨文公司拥有）创建的文档生成器，用于从Java源代码生成HTML格式的API文档，HTML格式用于增加将相关文档链接在一起的便利性。 Javadoc使用的“doc comments”格式 是记录Java类的事实上的行业标准。一些IDE，如IntelliJ IDEA、NetBeans和Eclipse，可以自动生成Javadoc HTML。许多文件编辑器帮助用户生成Javadoc源代码并使用Javadoc信息作为程序员的内部引用。 Javadoc还提供了用于创建doclet和taglet的API，允许用户分析Java应用程序的结构，这就是JDiff如何生成两个API版本之间发生变化的报告。 Javadoc不影响Java中的性能，因为在编译时会删除所有注释。编写注释和Javadoc是为了更好地理解代码，从而更好地维护代码。 (zh) Javadoc — генератор документації в HTML-форматі з коментарів вихідного коду на Java від Sun Microsystems. Цей формат був обраний для забезпечення можливості зв'язати воєдино пов'язані документи за допомогою посилань. Коментарі javadoc стали «де факто» стандартом для документування створених Java-класів. Більшість середовищ розробки, таких як Eclipse та Netbeans автоматично генерують документацію за допомогою javadoc. Javadoc також забезпечує інтерфейс для створення доклетів та теглетів, що надають можливість аналізувати структуру Java-програми. (uk) |
| dbo:wikiPageExternalLink | http://globaldocs.info/ https://javadoc.allimant.org/ https://docs.oracle.com/en/java/javase/13/javadoc/javadoc.html https://docs.oracle.com/javase/9/javadoc/javadoc-command.htm%23JSJAV-GUID-04BFA924-7C45-4E9C-91D1-0B77D97E65AB https://www.jcp.org/en/jsr/detail%3Fid=260 https://web.archive.org/web/20130927133806/https:/today.java.net/pub/a/today/2004/08/26/ashkelon.html |
| dbo:wikiPageID | 1329358 (xsd:integer) |
| dbo:wikiPageLength | 13132 (xsd:nonNegativeInteger) |
| dbo:wikiPageRevisionID | 1121575531 (xsd:integer) |
| dbo:wikiPageWikiLink | dbr:Java_Specification_Request dbr:Comparison_of_documentation_generators dbr:Application_programming_interface dbr:C_Sharp_syntax dbr:Documentation_generator dbr:HeaderDoc dbc:Java_development_tools dbr:Doxygen dbr:Eclipse_(software) dbr:PDF dbr:Unified_Modeling_Language dbr:HTML dbr:JSDoc dbr:Java_(programming_language) dbr:Java_Development_Kit dbr:Hyperlink dbr:API dbr:Sun_Microsystems dbc:Free_documentation_generators dbr:Doclets dbr:Integrated_Development_Environment dbr:IntelliJ_IDEA dbr:NetBeans dbr:Oracle_Corporation |
| dbp:wikiPageUsesTemplate | dbt:Citation_needed dbt:Reflist dbt:Short_description dbt:Manual |
| dcterms:subject | dbc:Java_development_tools dbc:Free_documentation_generators |
| gold:hypernym | dbr:Generator |
| rdf:type | dbo:Software yago:Apparatus102727825 yago:Artifact100021939 yago:Equipment103294048 yago:Generator103434188 yago:Implement103563967 yago:Instrumentality103575240 yago:Object100002684 yago:PhysicalEntity100001930 yago:WikicatJavaDevelopmentTools yago:Tool104451818 yago:Whole100003553 yago:WikicatDocumentationGenerators yago:WikicatFreeDocumentationGenerators |
| rdfs:comment | Javadoc ist ein Software-Dokumentationswerkzeug, das aus Java-Quelltexten automatisch HTML-Dokumentationsdateien erstellt. Javadoc wurde ebenso wie Java von Sun Microsystems entwickelt und ist ab Version 2 ein Bestandteil des Java Development Kits. Die Dokumentation kann durch spezielle Kommentare im Quelltext angereichert werden, hierbei kommen Tags zum Einsatz, die dazu dienen, z. B. Interfaces, Klassen, Methoden und Felder näher zu beschreiben. Neben der Standardausgabe in HTML sind alternative Ausgaben durch spezielle Doclets möglich. Dies ist eine einfache Form des Literate programming. (de) Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente. Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API. (es) Javadoc est un outil développé par Oracle, permettant de créer une documentation d'API en format HTML depuis les commentaires présents dans un code source en Java. Conçu à l'origine par Sun MicroSystems (avant son rachat par Oracle), javadoc est le standard industriel pour la documentation des classes Java. La plupart des IDE génèrent automatiquement la javadoc au format HTML. (fr) Javadocとは、サン・マイクロシステムズが開発したコンピュータソフトで、JavaのソースコードからHTML形式のAPI仕様書を生成するものである。 JavadocはJavaクラスの仕様書の標準の書式であり、多くのIDEは自動的にJavadoc HTMLを生成する機能を備えている。 なお、HTML形式は標準の書式であり、カスタマイズにより変更可能である。 (ja) Javadoc è un applicativo incluso nel Java Development Kit della Sun Microsystems, utilizzato per la generazione automatica della documentazione del codice sorgente scritto in linguaggio Java. (it) Javadoc – narzędzie automatycznie generujące dokumentację na podstawie zamieszczonych w kodzie źródłowym znaczników w komentarzach. Javadoc został stworzony specjalnie na potrzeby języka programowania Java przez firmę Sun Microsystems. Wiele nowoczesnych IDE wspomaga tworzenie dokumentacji i pozwala na automatyczne jej generowanie. Umożliwiają one również wykorzystanie takiej dokumentacji jako pomoc dla programisty podczas pisania kodu. (pl) Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java от Sun Microsystems. Javadoc — стандарт для документирования классов Java. Большинство сред разработки программного обеспечения автоматически генерируют HTML-документацию, используя Javadoc. Javadoc также предоставляет API для создания доклетов и , которые позволяют программисту анализировать структуру Java-приложения. (ru) Javadoc är ett verktyg som utvecklats av Sun Microsystems för att på ett standardiserat sätt skapa dokumentation till javaprojekt. Javadoc genererar dokumentation i HTML-format utifrån kommentarer i källkoden som följer en speciell syntax. Denna programmeringsrelaterade artikel saknar väsentlig information. Du kan hjälpa till genom att lägga till den. (sv) Javadoc（最初是JavaDoc）是由Sun Microsystems为Java语言（现在由甲骨文公司拥有）创建的文档生成器，用于从Java源代码生成HTML格式的API文档，HTML格式用于增加将相关文档链接在一起的便利性。 Javadoc使用的“doc comments”格式 是记录Java类的事实上的行业标准。一些IDE，如IntelliJ IDEA、NetBeans和Eclipse，可以自动生成Javadoc HTML。许多文件编辑器帮助用户生成Javadoc源代码并使用Javadoc信息作为程序员的内部引用。 Javadoc还提供了用于创建doclet和taglet的API，允许用户分析Java应用程序的结构，这就是JDiff如何生成两个API版本之间发生变化的报告。 Javadoc不影响Java中的性能，因为在编译时会删除所有注释。编写注释和Javadoc是为了更好地理解代码，从而更好地维护代码。 (zh) Javadoc — генератор документації в HTML-форматі з коментарів вихідного коду на Java від Sun Microsystems. Цей формат був обраний для забезпечення можливості зв'язати воєдино пов'язані документи за допомогою посилань. Коментарі javadoc стали «де факто» стандартом для документування створених Java-класів. Більшість середовищ розробки, таких як Eclipse та Netbeans автоматично генерують документацію за допомогою javadoc. Javadoc також забезпечує інтерфейс для створення доклетів та теглетів, що надають можливість аналізувати структуру Java-програми. (uk) javadoc je softwarová pomůcka (utilita) firmy Sun Microsystems™ pro automatické generování dokumentace k programu. Jedná se o co do velikosti malou konzolovou aplikaci, která umí procházet zdrojový kód programů v jazyku Java™, vyhledávat speciálně uvozené komentáře a ty posílat na výstup současně generovaného HTML souboru.Pro některé softwarového vývojáře je představa, že po dokončení určité verze svého projektu, budou muset ještě trávit několik hodin vypracováváním dokumentace, nepříjemná – musí totiž znovu procházet veškeré zdrojové kódy, popisovat každou funkci, konstantu nebo třídu, snažit se o jednotný vzhled, atd. Pokud používají javadoc a dodržují alespoň základní komentování ve svých zdrojových kódech, mohou přímo z nich dokumentaci vygenerovat okamžitě bez jakékoli práce navíc. (cs) Javadoc (originally cased 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. 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. (en) Javadoc is een documentatiegenerator uit de Java Development Kit (JDK), waarmee HTML-pagina's met API-documentatie worden gemaakt. API documentatie wordt gebruikt om een programma te beschrijven, het geeft aan in welke packages en klassen een Java programma is ingedeeld, welke variabelen en methoden er zijn, en wat ze precies doen in het programma. Javadoc is de industriestandaard voor het documenteren van Java programma's, en de meeste Integrated Development Environments (IDE) zullen automatisch javadoc documentatie genereren. Een voorbeeld van het gebruik: (nl) Javadoc é um gerador de documentação criado pela Sun Microsystems para documentar a API dos programas em Java, a partir do código-fonte. O resultado é expresso em HTML. É constituído, basicamente, por algumas marcações muitos simples inseridas nos comentários do programa. Este sistema é o padrão de documentação de classes em Java, e muitas dos IDEs desta linguagem irão automaticamente gerar um Javadoc em HTML. (pt) |
| rdfs:label | Javadoc (cs) Javadoc (de) Javadoc (es) Javadoc (en) Javadoc (it) Javadoc (fr) Javadoc (nl) Javadoc (ja) Javadoc (pl) Javadoc (pt) Javadoc (ru) Javadoc (sv) Javadoc (uk) Javadoc (zh) |
| owl:sameAs | freebase:Javadoc yago-res:Javadoc wikidata:Javadoc dbpedia-cs:Javadoc dbpedia-de:Javadoc dbpedia-es:Javadoc dbpedia-fr:Javadoc dbpedia-it:Javadoc dbpedia-ja:Javadoc dbpedia-nl:Javadoc dbpedia-nn:Javadoc dbpedia-no:Javadoc dbpedia-pl:Javadoc dbpedia-pt:Javadoc dbpedia-ru:Javadoc dbpedia-sv:Javadoc dbpedia-tr:Javadoc dbpedia-uk:Javadoc dbpedia-zh:Javadoc https://global.dbpedia.org/id/Qh6m |
| prov:wasDerivedFrom | wikipedia-en:Javadoc?oldid=1121575531&ns=0 |
| foaf:isPrimaryTopicOf | wikipedia-en:Javadoc |
| is dbo:wikiPageRedirects of | dbr:Doclet dbr:Doc_comments dbr:Doclets dbr:JavaDoc dbr:Java_Doc dbr:Java_doc dbr:Javadocs |
| is dbo:wikiPageWikiLink of | dbr:Qooxdoo dbr:Qshell dbr:NDoc dbr:Pdoc dbr:Visual_J_Sharp dbr:Ddoc dbr:Design_marker dbr:Interface_(Java) dbr:JDiff dbr:Jakarta_Messaging dbr:Software_archaeology dbr:Comparison_of_Java_and_C++ dbr:Comparison_of_documentation_generators dbr:Pydoc dbr:Classpath dbr:Code_folding dbr:Modular_Audio_Recognition_Framework dbr:Mxparser dbr:Aptana dbr:Comment_(computer_programming) dbr:Comparison_of_document_markup_languages dbr:Comparison_of_programming_languages_(syntax) dbr:Doclet dbr:Perl_module dbr:Plain_Old_Documentation dbr:C_Sharp_syntax dbr:Documentation_generator dbr:HeaderDoc dbr:Locale_(computer_software) dbr:Abas_ERP dbr:Adobe_ColdFusion dbr:Doxygen dbr:Extensible_Metadata_Platform dbr:Number_sign dbr:PL/pgSQL dbr:List_of_SIMILE_projects dbr:Software_documentation dbr:JSDoc dbr:Java_(programming_language) dbr:Java_Database_Connectivity dbr:Java_Development_Kit dbr:API_writer dbr:Abstract_Window_Toolkit dbr:Checkstyle dbr:Chemistry_Development_Kit dbr:Coding_conventions dbr:Java_Community_Process dbr:Java_Modeling_Language dbr:Java_annotation dbr:Java_package dbr:Java_syntax dbr:Spring_Security dbr:Doc_comments dbr:Doclets dbr:Natural_Docs dbr:ROBODoc dbr:ReStructuredText dbr:XDoclet dbr:XQuery_API_for_Java dbr:Literate_programming dbr:Event_(computing) dbr:Event_dispatching_thread dbr:VBdocman dbr:JavaDoc dbr:PHPDoc dbr:Java_Doc dbr:Java_doc dbr:Javadocs |
| is foaf:primaryTopic of | wikipedia-en:Javadoc |