| dbpprop:abstract
|
- A documentation generator is a programming tool that generates documentation intended for programmers or end users, or both, from a set of specially commented source code files, and in some cases, binary files. Document generation can be divided in several type of documents: Batch documents (all automated documents) Interactive documents (documents that can not be produced automatically) Text block correspondence (documents created based on pre defined text blocks) Forms (forms for websites) You can place every type of document you come across in one of these categories. A lot of software solutions are offered on the Internet that can automate these processes. In particular, some integrated development environments provide interactive access to documentation, code metadata, etc.
- Ein Software-Dokumentationswerkzeug dient zur automatischen Erzeugung von Dokumentationen aus den Ergebnissen und Objekten des Softwareentwicklungsprozesses. Die Dokumentation ist dabei jedoch keinesfalls nur auf den Quellcode beschränkt. Dokumentationswerkzeuge erlauben die Generierung von Dokumenten aus verschiedenen Quellen, sie unterstützen verschiedene Layoutvorgaben und unterschiedliche Ausgabeformate. Ein sehr verbreitetes Software-Dokumentationswerkzeug für die Programmiersprache Java ist Javadoc. Doxygen dagegen wird gerne für C++ benutzt, ist aber ein Dokumentationswerkzeug, dass mehrere Sprachen und verschiedene Ausgabeformate wie z. B. LaTeX, HTML und PDF unterstützt. Ein ähnliches Dokumentationswerkzeug ist Natural Docs. Das in Perl geschriebene Dokumentationswerkzeug kommt — im Gegensatz zu Javadoc und Doxygen — jedoch ganz ohne Tags aus und versucht, die Dokumentation aus möglichst lesbaren, "natürlich" aussehenden Kommentaren zu erzeugen.
- Generátor dokumentace je softwarová utilita (spadající do skupiny CASE nástrojů), schopná parsovat zdrojový kód, extrahovat z jeho komentářů informace určené pro dokumentaci a tyto informace poté zobrazit nebo zformátovat a poslat na výstup ve zvolené formě. Generátor dokumentace začíná syntaktickou analýzou hlavního zdrojového souboru. Při analýze si všímá komentářů – pokud je komentář navíc uvozen dohodnutou sekvencí znaků, začlení jeho obsah mezi dokumentaci, jež bude záhy generovat. Detekuje též příkazy/direktivy vkládání (inkludování) pomocných souborů, které zahrne k souborům, jež má projít. Většina lepších generátorů dokumentace umí vysledovat kontext aktuálního komentáře, popřípadě co jej bezprostředně předchází nebo následuje. Výsledné získané informace mají charakter hierarchicky strukturovaných článků – každý článek týkající se jednoho syntaktického prvku v daném projektu. Mezi výstupními formáty, který tento typ obsahu umí efektivně pojmout, tedy většinou nechybí formáty DocBook, vícestránkové HTML, soubory nápovědy v systému Windows (. hlp, . chm) a Unix (tzv. „man pages“) a mnohé další. Výhodou takto generované dokumentace je neoddělitelnost a konzistentnost dokumentace a kódu ve své zdrojové podobě, a z toho vyplývající možnost pohodlně dokumentovat zdrojový kód bez nutnosti neustále přepínat mezi IDE prostředím a externím textovým editorem a případě větších změn ve zdrojovém souboru tyto změny dodatečně a pracně vyhledávat a postihovat v dokumentaci a snažit se ji synchronizovat s aktuálním stavem zdrojového kódu. Pravděpodobně nejpoužívanější formát dokumentace je Javadoc, který využívá víceřádkové komentáře (ohraničené sekvencí znaků /** ... */). Příkladem generátoru dokumentace v tomto formátu je nástroj Doxygen.
- Un generador de documentación es una herramienta de programación que genera documentación destinada a los programadores (documentación de API) o a usuarios finales, o a ambos, a partir de un conjunto de código fuente especialmente documentado, y en algunos casos, archivos binarios.
- Un générateur de documentation est un outil de programmation qui crée de la documentation destinée aux programmeurs (il s'agit alors d'une documentation d'API) ou aux utilisateurs finaux (il s'agit alors d'un guide d'utilisateur) ou encore les deux. Pour gérer ces documentations, le générateur se base sur des codes sources commentés d'une certaine façon et dans certains cas également sur des fichiers binaires.
- ドキュメンテーションジェネレータ (documentation generator)は、特別なコメントが記述されたソースコードファイルの集合、または一部の例ではバイナリファイルの集合から、プログラマやエンドユーザまたはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。
- Een documentatiegenerator is een computerprogramma waarmee automatisch documentatie gegenereerd kan worden uit commentaar in de broncode of uit binaire bestanden. Deze documentatie is bedoeld voor andere programmeurs als beschrijving van de API. De meeste documentatiegeneratoren genereren de documentatie alsHTML maar ook andere formaten worden ondersteund, zoals CHM, RTF, PDF, LaTeX, PostScript of XML. Voorbeelden van documentatiegeneratoren zijn Javadoc, Haddock en Doxygen (voor allerlei talen). Sommige documentatiegeneratoren bieden uitgebreide mogelijkheden om de opmaak en het formaat van de gegenereerde documentatie aan te passen. Voorbeelden hiervan voor documentatie in (X)HTML zijn het gebruik van CSS, XSLT of sjablonen voor de lay-out van de pagina.
- Генератор документации — программа или пакет программ, позволяющая получать документацию, предназначенную для программистов и/или для конечных пользователей системы, по особым образом комментированному исходному коду и, в некоторых случаях, по исполняемым модулям (полученным на выходе компилятора). Обычно, генератор анализирует исходный код программы, выделяя синтаксические конструкции, соответствующие значимым объектам программы (типам, классам и их членам/свойствам/методам, процедурам/функциям nobr|и т. п.). В ходе анализа также используется мета-информация об объектах программы, представленная в виде документирующих комментариев. На основе всей собранной информации формируется готовая документация, как правило, в одном из общепринятых форматов — HTML, HTMLHelp, PDF, RTF и других.
|
| rdfs:comment
|
- A documentation generator is a programming tool that generates documentation intended for programmers or end users, or both, from a set of specially commented source code files, and in some cases, binary files.
- Ein Software-Dokumentationswerkzeug dient zur automatischen Erzeugung von Dokumentationen aus den Ergebnissen und Objekten des Softwareentwicklungsprozesses. Die Dokumentation ist dabei jedoch keinesfalls nur auf den Quellcode beschränkt. Dokumentationswerkzeuge erlauben die Generierung von Dokumenten aus verschiedenen Quellen, sie unterstützen verschiedene Layoutvorgaben und unterschiedliche Ausgabeformate.
- Generátor dokumentace je softwarová utilita (spadající do skupiny CASE nástrojů), schopná parsovat zdrojový kód, extrahovat z jeho komentářů informace určené pro dokumentaci a tyto informace poté zobrazit nebo zformátovat a poslat na výstup ve zvolené formě. Generátor dokumentace začíná syntaktickou analýzou hlavního zdrojového souboru.
- Un generador de documentación es una herramienta de programación que genera documentación destinada a los programadores (documentación de API) o a usuarios finales, o a ambos, a partir de un conjunto de código fuente especialmente documentado, y en algunos casos, archivos binarios.
- Un générateur de documentation est un outil de programmation qui crée de la documentation destinée aux programmeurs (il s'agit alors d'une documentation d'API) ou aux utilisateurs finaux (il s'agit alors d'un guide d'utilisateur) ou encore les deux. Pour gérer ces documentations, le générateur se base sur des codes sources commentés d'une certaine façon et dans certains cas également sur des fichiers binaires.
- ドキュメンテーションジェネレータ (documentation generator)は、特別なコメントが記述されたソースコードファイルの集合、または一部の例ではバイナリファイルの集合から、プログラマやエンドユーザまたはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。
- Een documentatiegenerator is een computerprogramma waarmee automatisch documentatie gegenereerd kan worden uit commentaar in de broncode of uit binaire bestanden. Deze documentatie is bedoeld voor andere programmeurs als beschrijving van de API. De meeste documentatiegeneratoren genereren de documentatie alsHTML maar ook andere formaten worden ondersteund, zoals CHM, RTF, PDF, LaTeX, PostScript of XML.
|
![[RDF Data]](/statics/sw-cube.png)
