Natural Docs. Natural Docs - Open-Source, erweiterbar, mehrsprachiger Dokumentationsgenerator
Jetzt downloaden

Natural Docs. Ranking & Zusammenfassung

Natural Docs. Stichworte

generieren Generator Dokumentation generieren Dokumentationsgenerator. Dokumentationserzeugung. Documetation.

Natural Docs. Beschreibung

Natural Docs - Open-Source, erweiterbar, mehrsprachiger Dokumentationsgenerator Natural Docs ist ein offener, erweiterbarer, mehrsprachiger Dokumentationsgenerator. Sie müssen Ihren Code nur in einer natürlichen Syntax dokumentieren, die wie einfaches Englisch lautet. Natural Docs scannen dann Ihren Code und erstellen eine hochwertige HTML-Dokumentation darin. Hier sind einige wichtige Funktionen von "Natural Docs": Source-Dokumentation natürliche, lesbare Syntax: · Die Syntax von Natural Docs ist so konzipiert, dass sie sehr natürlich aussehen, fast transparent. Die Kommentare in dem Quellcode lesen genauso einfach wie die erzeugte Dokumentation. Es gibt praktisch keine Tags, die überfällt. Mehrere Sprachen: · Natürliche Dokumente unterstützt neunzehn Programmiersprachen außerhalb des Felds, auch innerhalb desselben Projekts. Es unterstützt CGI- und ausgefahrene Dateien, da sie ihre Sprache anhand ihrer Shebang-Linien ermitteln kann. Fügen Sie Ihre eigene Sprache hinzu: · Wenn Ihre Programmiersprache noch nicht in Natural Docs enthalten ist, können Sie sie nur durch Bearbeiten einer Konfigurationsdatei unterstützen. Sogar die obskure Sprache kann einen leistungsstarken Dokumentationsgenerator haben. Alle oder nur explizite Dokumentation: · Abhängig von Ihrem Sprachunterstützungsniveau können Sie zwischen Natural Docs ALLES oder nur das dokumentieren, was Sie dokumentiert haben, wählen, was es zum Erzeugen von API-Referenzen eignet. Flexible Keywords: · Natural Docs Hat viele Keywords für jedes seiner Thementypen, sodass Sie die natürlichsten naturbelassen können. Sie können auch die vorhandenen anpassen oder Ihre eigenen hinzufügen. Benutzerdefinierte Themen und Indizes: · Wenn Sie einige Facetten Ihres Codes dokumentieren möchten, über das natürliche Dokumente nicht weißt Natürliche Dokumente werden sogar den eigenen Index aufbauen. Listen: · Natural Docs bietet eine abgekürzte Syntax zur Dokumentation großer Gruppen von kleinen Gegenständen wie Konstanten. Jeder wird ein verknüpftes Symbol, als hätte sie ein eigenes Thema. Erzeugte Ausgabebetriebsdokumentation: · Im Gegensatz zu den meisten generierten Dokumentationen sieht die Ausgabe von Natural Docs standardmäßig professionell aus. Es gibt verschiedene Stile zur Auswahl, oder Sie können selbst einen machen. Leistungsstarke CSS-Struktur: · Natürliche Dokumente hat eine leistungsstarke, gut dokumentierte CSS-Struktur, die vollständige Anpassung ermöglicht. Obwohl die Standardstile es nicht immer aufzeigen, können Sie Dinge wie Links zu Funktionen tun, um einen Stil und Links zu Klassen zu einem anderen zu sein. Sie können sogar browserspezifische Stile in einer einzelnen CSS-Datei verfügen, um sich um Rendering CArks zu arbeiten. Transparent versäumte E-Mail-Adressen: · E-Mail-Adressen, die in der Dokumentationslook auftreten und sich wie reguläre E-Mail-Links handeln, sind jedoch transparent, um Spam-Crawler zu vermeiden. Tooltips überall: · Jeder Link zu jedem dokumentierten Thema hat seine Zusammenfassung als Tooltip. Links zu Funktionen und Variablen haben ihre vollständig formatierten Provispee in den Tooltips. Gerahmtes oder ungerahmtes HTML: · Es ist Ihre Dokumentation, also ist es Ihre Wahl. Sie können jede Seite unabhängig und einfach verknüpft sein, oder Sie können das Menü in einem separaten Rahmen für eine einfachere Navigation aufbewahren. Präfixe im Index ignorieren: · Häufige Präfixe müssen Ihre Indizes nicht ruinieren. Wenn alle Ihre Klassen mit c beginnen, oder wenn Sie eine Reihe von Funktionen haben, die mit COM_ beginnen, können Sie natürliche Docs ignorieren, sodass CCAT, CDOG, CDOG und CMouse in C, D und M anstelle von allen unter C.-Programm erscheint Hoch automatisiert: · Natürliche Docs erkennt, welche Teile Ihrer Quellbaumänderung ändern und die Dokumentation entsprechend anpassen. Es wird automatisch das Menü aufrechterhalten und organisiert, wenn Sie es nicht selbst tun. Es wird automatisch die Dokumentation neu erstellt, wenn die Befehlszeilen- oder Konfigurationsdatei Änderungen erfordern. Differential Build-Prozess: · Natürliche Dokumente erstellt nur die geänderten Dateien, die seit seinem letzten Lauf geändert oder hinzugefügt wurden, und die von ihnen abhängigen Dateien, die die Laufzeit drastisch reduzieren und es für größere Projekte geeignet sind. Extensible Architektur: · Natürliche Dokumente sind so konzipiert, dass sie problemlos für verschiedene Programmiersprachen, Themen und CSS-Stile erweitert werden, die alle auf dieser Website dokumentiert sind. Intelligente Konfigurationsdateien: · Natürliche Dokumente erkennt Änderungen, die Sie auf den Konfigurationsdateien erstellen, und werden mit den kleineren Details selbst behandelt. Sie reformieren automatisch neu, sodass Sie schnell und schmutzige Bearbeitungen erstellen können und die Lesbarkeit noch aufrechterhalten. Projektkonfigurationsdateien halten eine aktuelle Liste der in den wichtigsten Dateien definierten Dinge, sodass Sie wissen, was Sie überschreiben können, ohne sie zu konsultieren. Portable: · Natürliche Dokumente läuft überall Perl-Läufe, und das ist ziemlich viele Orte. Frei und offen: · Natürliche Dokumente ist unter der GPL lizenziert, daher gibt es keine Gebühr und Sie können sich mit der Quelle mit der Freude Ihres Herzens fummeln.

Natural Docs. Zugehörige Software