ドキュメンテーション

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

ファイルへのリマインダーの追加

ファイルに注釈を付けることにより、後で改善、完成、更新するときに、コードの注釈の箇所を簡単に検索できるようになります。ファイルに注釈を付けるには、テキスト TODOFIXME、あるいは任意に選択したテキストによりコメントを追加します。ファイルに注釈を付けた後、TODO/FIXME レポートを実行し、所定のフォルダー内の注釈を付けたすべての MATLAB® コード ファイルを識別します。

このサンプル TODO/FIXME レポートには、TODO、FIXME、NOTE のテキストを含むファイルが表示されます。検索では大文字小文字を区別しません。

TODO/FIXME レポートの取り扱い

  1. [現在のフォルダー] ブラウザーを使用して、TODO/FIXME レポートの作成対象とするファイルが格納されているフォルダーに移動します。

    メモ

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

  2. [現在のフォルダー] ブラウザーで をクリックし、[レポート][TODO/FIXME レポート] を選択します。

    TODO/FIXME レポートが MATLAB Web ブラウザーに開かれます。

  3. TODO/FIXME レポート ウィンドウで、以下の 1 つまたは複数を選択し、レポートに含める行を指定します。

    • TODO

    • FIXME

    • テキスト フィールド チェック ボックス

      その後、このフィールドに正規表現を含む任意のテキストを入力できます。たとえば NOTEtbdre.*check などを入力します。

    カスタム テキストや検索する行の指定は MATLAB Online™ ではサポートされていません。

  4. [前回のフォルダーでレポートを再実行] をクリックし、現在のフォルダーでファイルのレポートを実行します。

    ウィンドウが更新され、ステップ 1 で選択したテキストを含む指定フォルダー内の MATLAB ファイルにあるすべての行がリストされます。この検索結果の一致は大文字と小文字を区別しません。

    レポート ウィンドウで現在指定されている以外のフォルダーでレポートを実行する場合は、現在のフォルダーを変更します。次に、[現在のフォルダーでレポートを実行] をクリックします。

エディターに指定した行の位置でファイルを開くには、レポートの行番号をクリックします。必要に応じてファイルに変更を加えます。

現在のフォルダーにファイル area.m があるとします。area.m のコードは以下のようになります。

テキスト TODO および FIXME を選択し、テキスト NOTE を指定して選択した状態で、area.m を含むフォルダーに対して TODO/FIXME レポートを実行すると、以下のリストが表示されます。

9 and rectangle.(todo)
14 fIXME: Is the area of hemisphere as below?
17 fIXME
21 NOTE: Find out from the manager if we need to include

レポートは以下を含みます。

  • 9 行目にテキスト TODO があります。レポートには、それがコメント内に配置されていても、選択したテキストがある行が含まれます。

  • 14 行目と 17 行目にテキスト FIXME があります。レポートには、大文字小文字に関係なく、ファイル内の選択したテキストが含まれます。

  • 21 行目にテキスト NOTE があります。レポートには、テキスト フィールドで指定したテキストが含まれます (テキスト フィールドを選択する場合)。