2016-06-01 10 views
1

Ich erstelle ein MATLAB-Paket mit objektorientierter Programmierung. Ich habe meine Klassen nach einer tutorial von MathWorks Website dokumentiert. Dieser Standard der Dokumentation funktioniert jedoch nur für doc und help Befehle, aber nicht, wenn ich publish verwende. Zum Beispiel haben Eigenschaften, deren Beschreibung vor ihre Deklaration geschrieben wurde, diese Deklaration nicht in HTML exportiert. Es gibt keine Liste von Eigenschaften oder Methoden am Anfang der Datei, so dass Benutzer schnell zu diesen springen können. Schließlich muss die Dokumentation direkt aus den Kommentaren im Code gelesen werden, anstatt in HTML geparst zu werden.MATLAB-Klassendokumentation in HTML veröffentlichen

Wenn ich versuche, einige HTML-Dokumentation innerhalb meiner Klassen zu publish ihnen hinzuzufügen, der Code erscheint auch auf doc und help, die ein unerwünschtes Verhalten ist. Gibt es eine Möglichkeit, eine Klassendokumentation zu erstellen, damit Eigenschaften und Methoden im Web veröffentlicht werden können? Ich habe Erfahrung mit Doc-Generatoren wie Sphinx (Python) und Doxygen (viele Sprachen), in denen die Beschreibungen von Klassen, Methoden und Eigenschaften in HTML analysiert werden, so dass sie in Orten wie Read the Docs oder GitHub Pages veröffentlicht werden kann, so bin ich neugierig um zu wissen, ob MATLAB so etwas hat.

Antwort

0

Sie können versuchen, MTOC++, die Doxygen verwendet, daher die Standard Doxygen HTML-Dokumentation erstellt.

ich verwendet habe es bereits Quellcodedokumentation für Matlab Projekt mit Standard Matlab Funktionen, alte Klassendefinitionen mit @ Notation und Klassen definiert durch classdef gemischt, und es hat funktioniert nach einiger Schneiderei zu erzeugen.

Dieses etwas größere Projekt ermöglicht MatLab Dateien und Klassen (einschließlich Verpackungen) Dokumentation erstellen doxygen Filter namens MTOC++ verwenden. Darüber hinaus ermöglicht ein Werkzeug/eine Klasse namens MatlabDocMaker, die Dokumentation aus MatLab zu erstellen. Für Windows, Mac und Unix!

Sie können es auch auf Mathworks File Exchange finden, und Sie können die Dokumentation here finden.

0

Eine weit verbreitete Methode, HTML-Dokumentation für MATLAB-Funktionen/-Klassen bereitzustellen, ist das Projekt M2HTML. Es generiert automatisch HTML-Dokumentation mit Abhängigkeitsgraphen, Quellcode und Syntax-Highlighting.