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

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

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

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

Live script with a formatted title, text, code, and the resulting output figure

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

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

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

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

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

Code with green comments that include markup for a title, subheadings, and an equation

Published document that includes a title, subheadings, and formatted equations, as well as code and the resulting output

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

  1. MATLAB スクリプトまたは関数を作成します。各セクションの先頭に 2 つのパーセント記号 (%%) を挿入して、コードをステップまたはセクションに分割します。

  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 ではそれらの文字が文字化けして表示されます。

  3. コードをパブリッシュします。[パブリッシュ] タブで、[パブリッシュ] をクリックします。

    既定では、MATLAB は html という名前のサブフォルダーを作成します。ここには、コードが作成する HTML ファイルおよび各グラフィックス ファイルが格納されます。HTML ファイルには、コード、書式化されたコメントおよび出力が含まれます。また、PDF ファイルや Microsoft PowerPoint® プレゼンテーションなど、他の形式にパブリッシュすることもできます。他の形式へのパブリッシュの詳細については、出力ファイルの指定を参照してください。

    MATLAB Online™ で、パブリッシュ時に MATLAB が出力ウィンドウを自動的に開くようにするには、Web ブラウザーでポップアップ ウィンドウを有効にします。

コードのパブリッシュ後は、パブリッシュされたファイルが含まれるフォルダーを共有できます。詳細については、MATLAB Drive を使用したフォルダーの共有を参照してください。

ファイルの全画面表示

MATLAB でファイルを全画面表示して共有できます。エディターでファイルを開いた状態で、[ビュー] タブに移動し、[全画面表示] ボタンをクリックしてオンにします。エディターはファイルを全画面モードで表示します。または、キーボード ショートカットの Ctrl+F11 を使用することもできます。macOS では、キーボード ショートカットの Command+F11 を代わりに使用します。

全画面モードを終了するには、画面の上部にマウスを移動して [ビュー] タブを表示し、[全画面表示] ボタンをクリックしてオフにします。画面の右上にある [全画面表示の終了] ボタン を使用することもできます。

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

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

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

参考

トピック

外部の Web サイト