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

ヘルプ概要ファイル (Contents.m) の作成

Contents.m ファイルとは

Contents.m ファイルは特定フォルダーのプログラムの概要を提供します。関数 helpdoc および ver は、Contents.m ファイルを参照してフォルダーの情報を表示します。

Contents.m ファイルには、コメント行のみが含まれています。最初の 2 行はフォルダーを説明するヘッダーです。それに続く行では、フォルダー内のプログラム ファイルを説明とともにリストします。オプションとして、ファイルをグループ化してカテゴリの説明を含めることができます。たとえば、codetools フォルダーで利用できる関数を表示します。

help codetools
  Commands for creating and debugging code
  MATLAB Version 9.3 (R2017b) 24-Jul-2017 
 
  Editing and publishing
    edit                   - Edit or create a file
    grabcode               - Copy MATLAB code from published HTML
    mlint                  - Check files for possible problems
    publish                - Publish file containing cells to output file
    snapnow                - Force snapshot of image for published document
  
  Directory tools
    mlintrpt               - Run mlint for file or folder, reporting results in browser
    visdiff                - Compare two files (text, MAT, or binary) or folders

   ...

他のユーザーにプログラム ファイルの概要を "表示しない" ようにするには、フォルダーに空の Contents.m ファイルを置きます。空の Contents.m ファイルを使用すると、help foldername と指定したときに No help found for foldername とレポートされます。Contents.m ファイルがないと、help および doc コマンドはフォルダー内のすべてのプログラム ファイルの生成されたリストを表示します。

Contents.m ファイルの作成

フォルダーに一連の既存プログラム ファイルがある場合、Contents.m ファイルを作成する最も簡単な方法は、コンテンツ レポートを使用することです。コンテンツ レポートの主要な目的は、既存の Contents.m ファイルが最新であるかどうかをチェックすることです。ただし、Contents.m が存在するかどうかもチェックし、フォルダーの内容を基に新しいファイルを生成できます。ファイルを作成するには、次の手順に従います。

  1. [現在のフォルダー] ブラウザーで、プログラム ファイルを含んでいるフォルダーに移動します。

  2. をクリックし、[レポート][コンテンツ レポート] を選択します。

  3. Contents.m ファイルを作成するよう促されたレポートで、[はい] をクリックします。新しいファイルにはフォルダー内のすべてのプログラム ファイルの名前が含まれ、可能であれば説明行 (最初の空でないコメント行) を使用します。

  4. 生成されたファイルをエディターで開き、2 番目のコメント行が次の形式になるよう、ファイルを変更します。

         % Version xxx dd-mmm-yyyy

    日付にスペースを含めないでください。このコメント行があると、関数 ver でバージョン情報を検出できるようになります。

メモ

MATLAB® は、コンテンツ レポートの作成時に、ライブ スクリプトまたはライブ関数を含めません。

既存の Contents.m ファイルのチェック

以下のように、コンテンツ レポートを使用して Contents.m ファイルがフォルダーの現在の内容を反映しているかどうかを確認します。

  1. [現在のフォルダー] ブラウザーで、Contents.m ファイルを含んでいるフォルダーに移動します。

  2. をクリックし、[レポート][コンテンツ レポート] を選択します。

メモ

パスが UNC (Universal Naming Convention) パス名である場合、すなわちパスが \\ で始まる場合は、レポートを実行できません。代わりに、システム上の実際のハード ドライブまたはマッピングされているネットワーク ドライブを使用します。

コンテンツ レポートは以下のチェックを実行します。

確認する Contents.m ファイルの状態詳細
存在するContents.m ファイルがフォルダーに存在しない場合、レポートから作成できます。
フォルダー内のすべてのプログラムが含まれる欠けているプログラムはグレーで強調表示されます。エンド ユーザーに表示しないプログラムは、追加する必要はありません。
存在しないファイルが誤ってリストされているフォルダー内に存在しないプログラムがリストされている場合、ピンクで強調表示されます。
プログラム ファイルの説明が一致するレポートは、Contents.m のファイル説明と対応するファイル内の最初の空でないコメント行を比較します。不一致の部分はピンクで強調表示されます。プログラム ファイルまたは Contents.m ファイルのどちらかを更新できます。
ファイル名と説明の間隔が一定であるレポートの上部にある [間隔を修正] をクリックして配置を修正します。

[すべて修正] をクリックして提示された変更をすべて行ったり、[Contents.m を編集] をクリックしてエディターでファイルを開くことができます。

参考

| |