MATLAB コードのパブリッシュと共有

MATLAB^® には、コードを他のユーザーに提示するオプションがあります。MATLAB コードファイル (.m) をパブリッシュして書式設定されたドキュメントを作成したり、ライブエディター内でライブスクリプトおよびライブ関数を作成して共有することができます。

ライブエディターでのライブスクリプトの作成と共有

実行可能な MATLAB コード、埋め込みの出力、書式設定されたテキストを含む、まとまりのある共有可能なドキュメントを作成する最も簡単な方法は、ライブエディターを使用することです。サポートされている出力形式は、MLX、PDF、Microsoft^® Word、HTML、および LaTeX です。詳細については、ライブエディターでライブスクリプトを作成を参照してください。

MATLAB コードファイル (`.m`) のパブリッシュ

MATLAB コードファイル (.m) を使用して共有可能なドキュメントを作成するには、ファイルを "パブリッシュ" します。MATLAB コードファイルをパブリッシュして、コード、コメントおよび出力が含まれる書式設定されたドキュメントを作成します。コードをパブリッシュする一般的な理由は、教育またはデモ用にドキュメントを他のユーザーと共有したり、コードの読みやすい外部ドキュメンテーションを生成することです。

次のコードは、矩形波のフーリエ級数展開を示しています。

マークアップ付き MATLAB コード

パブリッシュされたドキュメント

コードをパブリッシュするには、以下の手順に従います。

MATLAB スクリプトまたは関数を作成します。各セクションの先頭に 2 つのパーセント記号 (%%) を挿入して、コードをステップまたはセクションに分割します。
ファイルの先頭と各セクション内に説明コメントを追加して、コードをドキュメント化します。
各セクションの先頭のコメントの中で、出力が読みやすくなるようにマークアップを挿入することができます。たとえば、上記の表のコードには次のマークアップが含まれます。
タイトル
%% Square Waves from Sine Waves
%% Add an Odd Harmonic and Plot It
%% Note About Gibbs Phenomenon
イタリックの変数名
% As _k_ increases, ...
LaTeX 式
% $$ y = y + \frac{sin(k*t)}{k} $$
メモ
プラットフォームとは異なるエンコードの文字を使用するテキストが含まれるファイルを保存またはパブリッシュすると、MATLAB ではそれらの文字が文字化けして表示されます。
コードをパブリッシュします。[パブリッシュ] タブで、[パブリッシュ] をクリックします。
既定では、MATLAB は html という名前のサブフォルダーを作成します。ここには、コードが作成する HTML ファイルおよび各グラフィックスファイルが格納されます。HTML ファイルには、コード、書式化されたコメントおよび出力が含まれます。また、PDF ファイルや Microsoft PowerPoint^® プレゼンテーションなど、他の形式にパブリッシュすることもできます。他の形式へのパブリッシュの詳細は、出力ファイルの指定を参照してください。
MATLAB Online™ で、パブリッシュ時に MATLAB が出力ウィンドウを自動的に開くようにするには、Web ブラウザーでポップアップウィンドウを有効にします。

コードのパブリッシュ後は、パブリッシュされたファイルが含まれるフォルダーを共有できます。詳細については、MATLAB でのフォルダーの共有を参照してください。MATLAB Online では、パブリッシュされたファイルを html フォルダーから Published フォルダーにコピーすることで、結果をパブリックに利用できるようにすることもできます。その後、https://matlab.mathworks.com/users/userid/Published/filename/index.html (HTML) または https://matlab.mathworks.com/users/userid/Published/foldername/filename.pdf (PDF) の形式の URL を使用してファイルを共有できます。

上記の図の中にあるサンプルコードは、インストールされたドキュメンテーションの一部です。次のコマンドを実行して、エディターでコードを表示できます。

edit(fullfile(matlabroot,'help','techdoc','matlab_env', ...
             'examples','fourier_demo2.m'))

ヘルプの追加とドキュメンテーションの作成

MATLAB コードファイルの最初にコメントを挿入することで、コードにヘルプを追加できます。MATLAB は、ユーザーがコマンドウィンドウに help file_name と入力するとヘルプコメントを表示します。詳細については、プログラムへのヘルプの追加を参照してください。

MATLAB ヘルプブラウザーまたは Web で表示するために独自の MATLAB ドキュメンテーショントピックを作成することもできます。詳細については、カスタムドキュメンテーションの表示を参照してください。

参考

publish

外部の Web サイト

MATLAB コードをエディターからパブリッシュする