ドキュメンテーション センター

  • 評価版
  • 製品アップデート

最新のリリースでは、このページがまだ翻訳されていません。 このページの最新版は英語でご覧になれます。

MATLAB コードのパブリッシュ

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

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

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

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

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

  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} $$

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

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

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

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

参考

詳細

この情報は役に立ちましたか?