| dbo:abstract
|
- Generátor dokumentace je softwarová utilita (spadající do skupiny CASE nástrojů), schopná (pomocí syntaktické analýzy) 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. (cs)
- 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 (z. B. UML-Diagramme, Quelltext), sie unterstützen verschiedene Layoutvorgaben und unterschiedliche Ausgabeformate (z. B. PostScript, PDF). Ein sehr verbreitetes Software-Dokumentationswerkzeug für die Programmiersprache Java ist Javadoc. Doxygen dagegen wird gern für C++ benutzt, ist aber ein Dokumentationswerkzeug, das mehrere Sprachen und verschiedene Ausgabeformate, wie z. B. LaTeX, HTML und PDF unterstützt. Ein ähnliches Dokumentationswerkzeug ist Natural Docs. Die für Perl verwendete Plain Old Documentation 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. Für die Programmiersprache Python wurde Sphinx entwickelt, ein Software-Dokumentationswerkzeug, welches reStructuredText in HTML-Seiten sowie viele weitere Formate wie PDF, EPUB und Manpages umwandelt. (de)
- A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods. (en)
- 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. (es)
- Un générateur de documentation est un 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 généralement sur des codes sources commentés d'une certaine façon et dans certains cas également sur des fichiers binaires. La documentation générée peut être hautement technique, et est principalement utilisée pour définir et expliquer les interfaces de programmation (APIs), les structures de données et les algorithmes. Par exemple, on peut utiliser cette documentation pour expliquer que la variable m_name se réfère au premier et au dernier nom d'une personne. Il est important pour les documents sur le code d'être précis, mais pas non plus verbeux à un point tel qu'il serait difficile de les maintenir. Les générateurs de documentation tels que Sphinx, doxygen ou javadoc génèrent automatiquement la documentation à partir du code source. Ils extraient le commentaire du code source et créent des manuels de référence sous des formats comme le texte, des fichiers HTML, PDF, DocBook, ou RTF. Les documents sur le code sont souvent organisés dans le style d'un guide de référence, ce qui permet à un programmeur de localiser rapidement une fonction ou une classe quelconque. L'avantage d'un générateur de documentation à partir du code source est la proximité du code source avec sa documentation codée sous forme de commentaires. Le programmeur peut alors l'écrire en se référant à son code, et peut utiliser les mêmes outils que ceux qu'il a utilisés pour développer le code source, pour faire la documentation. Cela rend beaucoup plus facile la mise à jour de la documentation. Bien sûr, l'inconvénient est que seuls les programmeurs peuvent éditer cette sorte de documentation, et c'est d'eux que dépend la mise à jour des sorties (par exemple, en exécutant un crontab pour mettre à jour les documents la nuit). Certains pourraient caractériser cela comme un avantage plutôt que comme un inconvénient. (fr)
- 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 als (X)HTML maar ook andere formaten worden ondersteund, zoals , RTF, PDF, LaTeX, PostScript of XML. Voorbeelden van documentatiegeneratoren zijn Javadoc (voor Java), Haddock (voor Haskell) 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. (nl)
- ドキュメンテーションジェネレータ (documentation generator)は、特別なコメントが記述されたソースコードファイルの集合、または一部の例ではバイナリファイルの集合から、プログラマ(APIドキュメンテーション)やエンドユーザ(エンドユーザーガイド)またはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。 (ja)
- Генератор документации — программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и, в некоторых случаях, по исполняемым модулям (полученным на выходе компилятора). Обычно генератор анализирует исходный код программы, выделяя синтаксические конструкции, соответствующие значимым объектам программы (типам, классам и их членам/свойствам/методам, процедурам/функциям и т. п.). В ходе анализа также используется мета-информация об объектах программы, представленная в виде документирующих комментариев. На основе всей собранной информации формируется готовая документация, как правило, в одном из общепринятых форматов — HTML, HTMLHelp, PDF, RTF и других. (ru)
- Генератор документації — програма або пакет програм, що дозволяє отримувати документацію, призначену для програмістів (документація на API) та/або для кінцевих користувачів системи, з особливим чином коментованого початкового коду і, в деяких випадках, з виконуваних модулів (отриманими на виході компілятора). Зазвичай генератор аналізує початковий код програми, виділяючи синтаксичні конструкції, що відповідають значущим об'єктам програми (типами, класам та їх членам/властивостями/методам, процедурам/функціям тощо). В ході аналізу також використовується мета-інформація про об'єкти програми, подана у вигляді документувальних коментарів. На основі всієї зібраної інформації формується готова документація, як правило, в одному із загальноприйнятих форматів HTML, HTMLHelp, PDF, RTF тощо. (uk)
|
| rdfs:comment
|
- A documentation generator is a programming tool that generates software documentation intended for programmers (API documentation) or end users (end-user guide), or both, from a set of source code files, and in some cases, binary files. Some generators, such as Javadoc, can use special comments to drive the generation. Doxygen is an example of a generator that can use all of these methods. (en)
- 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. (es)
- ドキュメンテーションジェネレータ (documentation generator)は、特別なコメントが記述されたソースコードファイルの集合、または一部の例ではバイナリファイルの集合から、プログラマ(APIドキュメンテーション)やエンドユーザ(エンドユーザーガイド)またはその両方を対象としたドキュメンテーションを生成するプログラミングツールである。 (ja)
- Generátor dokumentace je softwarová utilita (spadající do skupiny CASE nástrojů), schopná (pomocí syntaktické analýzy) 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ě. 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. (cs)
- 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 (z. B. UML-Diagramme, Quelltext), sie unterstützen verschiedene Layoutvorgaben und unterschiedliche Ausgabeformate (z. B. PostScript, PDF). (de)
- Un générateur de documentation est un 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 généralement sur des codes sources commentés d'une certaine façon et dans certains cas également sur des fichiers binaires. (fr)
- 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 als (X)HTML maar ook andere formaten worden ondersteund, zoals , RTF, PDF, LaTeX, PostScript of XML. Voorbeelden van documentatiegeneratoren zijn Javadoc (voor Java), Haddock (voor Haskell) en Doxygen (voor allerlei talen). (nl)
- Генератор документации — программа или пакет программ, позволяющая получать документацию, предназначенную для программистов (документация на API) и/или для конечных пользователей системы, по особым образом комментированному исходному коду и, в некоторых случаях, по исполняемым модулям (полученным на выходе компилятора). (ru)
- Генератор документації — програма або пакет програм, що дозволяє отримувати документацію, призначену для програмістів (документація на API) та/або для кінцевих користувачів системи, з особливим чином коментованого початкового коду і, в деяких випадках, з виконуваних модулів (отриманими на виході компілятора). (uk)
|
