Ich arbeite an gemeinsamem Matlab-Code und möchte eine generierte Dokumentation als durchsuchbare HTML-Dokumente in unserem lokalen Netzwerk teilen.Wie kann Matworks HTML-Dokumentation mit Mathworks generiert werden?
Ich kenne die folgenden Methoden, um eine Dokumentation zu generieren:
- einen Konverter zu C++ schreiben - wie Dateien. Dies geschieht in Using Doxygen with Matlab (Letzte Aktualisierung 2011) und mtoc++ (letzte Aktualisierung 2013). Die C++ - ähnlichen Dateien werden dann von Doxygen analysiert.
- Verwenden Sie Pythons sphinxcontrib-matlabdomain, um eine HTML-Dokumentation zu generieren.
- Verwenden Sie m2html, die auch eine Lösung von Drittanbietern ist.
- Weitere Optionen sind in dieser Q & As aufgeführt: One, Two und .
Alle Möglichkeiten werden von Mathworks nicht unterstützt. Alle Möglichkeiten müssen ich erwähnen, d. H. Die Parameter einer Funktion selbst. Sie analysieren nicht den Code in dem Sinne, Doxygen tut es für das heißt Java:
//! an object representation of the advertisement package sent by the beacon
private AdvertisementPackage advertisementPackage;
ich von Matlab publish() Funktion gehört, aber ich habe es nie im oben genannten Sinne gebraucht.
Frage: Was ist die Mathworks-Methode, Matlab HTML-Dokumentation zu generieren. Kann der Code selbst analysiert werden? Kann ich die Informationen, die dem Matlab Input Parser zur Verfügung gestellt werden, bereits verwenden? Bitte geben Sie Ihre persönlichen Präferenzen in Kommentaren an.
Beispiel:
%% Input parser
p = inputParser;
addRequired(p, 'x', @isnumeric);
validationFcn = @(x) (isnumeric(x) && isscalar(x));
addRequired(p, 'fftSize', validationFcn);
addRequired(p, 'fftShift', validationFcn);
validationFcn = @(x) (isa(x, 'function_handle'));
addRequired(p, 'analysisWindowHandle', validationFcn);
parse(p, x, fftSize, fftShift, analysisWindowHandle);
Um die von mir verfasste [MatlabDomain Sphinx Extension] (https://pypi.python.org/pypi/sphinxcontrib-matlabdomain) zu klären, analysiert _does_ Ihren Code und generiert automatisch ähnliche Dokumente wie Epydoc. Verwenden Sie die ['autosummary extension'] (http://sphinx-doc.org/latest/ext/autosummary.html), um Ihre gewünschte Quelle aufzulisten, und verwenden Sie dann [' sphinx-autogen'] (http: // sphinx- doc.org/latest/ext/autosummary.html?highlight=autogen) automatisch [autodoc] erzeugen (http://sphinx-doc.org/latest/ext/autodoc.html#module-sphinx.ext.autodoc) Stub-Dateien, dann erstellen Sie Ihre Dokumente. –
Wir haben uns jetzt entschieden, die Sphinx-Straße zu nehmen, da wir bei Problemen schnell und gute Rückmeldungen erhalten haben. – Lukas