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.