ford

FORD

Dies ist ein automatischer Dokumentationsgenerator für moderne FORTRAN -Programme. Ford steht für Forran DocumentReper. Wie Sie vielleicht wissen, bezieht sich "zu Ford" auf das Überqueren eines Flusses (oder andere Wasserkörper). In diesem Zusammenhang bezieht sich nicht auf ein Unternehmen oder eine Person, die mit Autos verbunden ist.

Ford wurde aufgrund von Doxygens schlechter Handhabung von Fortran und dem Mangel an vergleichbaren Alternativen geschrieben. Robodoc kann keine Informationen aus dem Quellcode extrahieren und fast jede andere automatische Dokumentationssoftware, die ich gefunden habe, war entweder proprietär, funktionierte für FORTRAN nicht sehr gut oder war in Bezug auf die Erzeugung seiner Ausgabe begrenzt. F90DOC ist ziemlich gut und ich habe es geschafft, es so zu ändern, dass es den größten Teil von Forran 2003 verarbeiten kann, aber es erzeugt eine ziemlich hässliche Dokumentation, kann nicht so viele Links zwischen verschiedenen Teilen der Dokumentation liefern, wie ich es mir wünschte, und ist in Perl geschrieben (mit denen ich nicht so vertraut bin und die in Python für die Erzeugung von HTML -Inhalten von HTML -Inhalten nicht so vertraut sind).

Das Ziel von Ford ist es, in der Lage zu sein, zuverlässig Dokumentationen für moderne Fortran -Software zu erstellen, die informativ und schön anzusehen ist. Die Dokumentation sollte einfach zu schreiben und in dem Code nicht aufzuheben sein. Während es niemals so featurzierreich wie Doxygen sein wird, kann Ford hoffentlich eine gute Alternative für die Dokumentation von FORTRAN-Projekten bieten.

Fähigkeiten

Aktuelle Funktionen umfassen:

• Die Fähigkeit, Informationen zu Variablen, Verfahren, Verfahrensargumenten, abgeleiteten Typen, Programmen und Modulen aus dem Quellcode zu extrahieren.
• Die Fähigkeit, Dokumentation aus Kommentaren im Quellcode zu extrahieren.
• Latex -Unterstützung in der Dokumentation mit Mathjax.
• Durchsuchbare Dokumentation mit Lunr -Suche.
• Beschreibung des Autors und soziale Medien (einschließlich Github!) Links.
• Links zum Herunterladen des Quellcodees.
• Links zu einzelnen Dateien, sowohl in ihrer Rohform als auch in HTML mit Syntax -Hervorhebung.
• Verwendung von Markdown für die Typ-Set-Dokumentation.
• Verbindungen zwischen verwandten Teilen der Software.
• Bootstrap CSS für die Dokumentation und macht es sowohl funktional als auch hübsch.
• Konfigurierbare Einstellungen.
• Fähigkeit, einen hierarchischen Satz von Seiten zu erstellen, die allgemeine Informationen enthalten, die nicht mit einem bestimmten Teil des Quellcode verbunden sind.
• Zeigen Sie einen Eintrag für Nicht-Forstran-Quelldateien mit Dokumentation auf Dateiebene und Syntax hervor.

Installation

Der einfachste Weg zur Installation von Ford ist die Verwendung von PIP:

 pip install ford

PIP wird automatisch alle Abhängigkeiten für Sie behandeln. Standardmäßig werden ford in ~/.local/bin eingerichtet - Sie müssen dies möglicherweise zu Ihrem PATH hinzufügen.

Alternativ ist Ford über den Homebrew -Paket -Manager für Mac OS X erhältlich. Um Homebrew zu aktualisieren und Ford zu installieren, führen Sie diese Befehle in einem Terminal aus:

 brew update
brew install FORD

Wenn Sie den neuesten Entwicklungszweig (Master) von GitHub installieren möchten, fügen Sie einfach das --HEAD : brew install --HEAD FORD hinzu

Ford ist auch über den Spack -Paket -Manager erhältlich, indem der folgende Befehl ausgeführt wird:

 spack install py-ford

Dokumentation

Eine vollständigere Dokumentation finden Sie in den Dokumenten.

Lizenz

Dieses Programm ist kostenlose Software: Sie können es neu verteilt und/oder unter den Bestimmungen der GNU General Public Lizenz wie von der Free Software Foundation, entweder Version 3 der Lizenz veröffentlicht, oder (nach Ihrer Option) jede spätere Version ändern.

Dieses Programm wird in der Hoffnung verteilt, dass es nützlich sein wird, aber ohne Kriege ; Ohne die implizite Garantie für Handelsfähigkeit oder Eignung für einen bestimmten Zweck . Weitere Informationen finden Sie in der GNU General Public Lizenz.

Sie hätten zusammen mit diesem Programm eine Kopie der GNU General Public Lizenz erhalten haben. Wenn nicht, lesen Sie die GNU -Website.

Dokumente, die von Ford erstellt wurden, sind abgeleitete Werke, die aus der in ihrer Produktion verwendeten Eingabe abgeleitet wurden. Sie sind nicht von dieser Lizenz betroffen.