2016-06-01 4 views
1

私はオブジェクト指向プログラミングを使用してMATLABパッケージを作成しています。 MathWorksのウェブサイトのtutorialに従ってクラスを文書化しました。しかし、このドキュメントの標準は、dochelpコマンドでのみ動作しますが、publishでは動作しません。例えば、宣言の前に記述された記述を持つプロパティは、HTMLに宣言された宣言を持っていません。ファイルの先頭にはプロパティやメソッドのリストがないため、ユーザーはそれらのプロパティやメソッドにすばやくスキップできます。最後に、HTMLに解析されるのではなく、コード内のコメントからドキュメントを直接読み込む必要があります。MATLABクラスのドキュメントをHTMLに公開

publishにクラス内のHTMLドキュメントを追加しようとすると、コードはdochelpにも表示されますが、これは望ましくない動作です。 プロパティとメソッドをWebに公開できるようにクラスのドキュメントを作成する方法はありますか?私はSphinx(Python)やDoxygen(多くの言語)のようなドキュメントジェネレータで、クラス、メソッド、プロパティの説明をHTMLに解析してRead the DocsGitHub Pagesなどの場所で公開できるようにしています。 MATLABにそのようなことがあるかどうかを知ることができます。

答えて

0

MTOC++にDoxygenを使用すると、標準のDoxygen HTMLドキュメントが作成されます。

標準のMatlab関数を含むMatlabプロジェクト、@表記の古いクラス定義、およびclassdefで定義されたクラスのソースコードのドキュメントを生成するために既に使用しています。

この少し大きいプロジェクトは MTOC++という名前のdoxygenのフィルターを使って、MATLAB ファイルと(パッケージを含む)クラスのドキュメントを作成することができます。さらに、MatlabDocMakerという名前のツール/クラスでは、 をMatLab内から作成することができます。 Windows、Mac、Unixの場合

Mathworks File Exchangeにも記載されています。hereのマニュアルもあります。

0

MATLAB関数/クラスのHTMLドキュメントを提供するために広く使われている方法の1つが、M2HTMLプロジェクトです。これは、依存関係グラフ、ソースコード、および構文ハイライトを含むHTMLドキュメントを自動的に生成します。

関連する問題