方法 : タスク一覧のコメントを作成する

  • [アーティクル]

更新 : 2007 年 11 月

[タスク一覧]には、開発言語のコメント マーカーで始まる、コード内のコメントが表示されます。[タスク一覧]には、コメントの隣に、TODO、HACK、UNDONE などの既定のタスク トークン、またはカスタムのコメント トークンも表示されます。[タスク一覧]に表示されるコメントの数は、作業しているプロジェクトの種類によって変わることがあります。Visual Basic および Visual C# の場合、ソリューション内のすべてのコメントが [タスク一覧] に表示されます。Visual C++ プロジェクトの場合、エディタで現在アクティブなファイル内で見つかるコメントのみが[タスク一覧]に表示されます。

タスク一覧のコメントを使用して、特定の位置で今後行う必要のある作業に印を付けておくことができます。次のような作業に使用できます。

  • 機能の追加

  • 問題の修正

  • クラスの実装

  • エラー処理コードの挿入

  • 後で確認の必要な箇所

タスク一覧の他のエントリと同様に、任意のコメント エントリをダブルクリックすると、指定されたファイルをコード エディタで開き、印の付いたコード行にジャンプできます。

タスク一覧にコメントを追加するには

  1. コード エディタでソース コード ファイルを開きます。

  2. 印を付けたいコード行に、<marker><token> の形式で始まるコメントを入力します。ここで、<marker> は開発言語に対応するコメント マーカーであり、<token> はタスク一覧のコメント トークンとして認識される名前 (TODO、HACK、UNDONE など) またはカスタム コメント トークンです。

    zce12xx2.alert_note(ja-jp,VS.90).gifメモ :

    タスク トークンをプログラムで追加するには、TaskList の DefaultCommentToken を設定します。

  3. タスクについてのコメントを入力します。たとえば、次のように入力します。

    // TODO Fix this function.

    または

    ' HACK Update this procedure.

  4. [表示] メニューの [タスク一覧] をクリックします。

    タスク一覧が表示されます。

  5. [カテゴリ] ボックスの一覧で [コメント] をクリックします。

    [コメント] リストにコメント テキストが表示されます。タスク一覧のコメントをクリックすると、対応するファイルがコード エディタでアクティブになり、コメント マークの付いたコード行にジャンプします。

コメントを変更するか、タスク一覧からコメントを削除するには

  1. コード ファイルをコード エディタで編集するために開きます。

  2. コードのコメントを変更するか、削除します。

コメントの既定の優先順位を変更するには

  1. [ツール] メニューの [オプション] をクリックします。

  2. [環境] フォルダを展開し、[タスク一覧] をクリックします。

  3. [トークン リスト] で、既定の優先順位を変更するコメント トークンを選択します。

    zce12xx2.alert_note(ja-jp,VS.90).gifメモ :

    TODO コメントの優先順位を変更することはできません。

  4. [優先順位] ボックスの一覧から異なる種類の優先順位を選択します。

  5. [OK] をクリックします。

カスタム コメント トークンを作成するには

  1. [ツール] メニューの [オプション] をクリックします。[環境] フォルダを展開し、[タスク一覧] をクリックします。

    [タスク一覧] ([オプション] ダイアログ ボックス - [環境]) が表示されます。

  2. [コメント トークン] ボックスで、[名前] ボックスにカスタム トークンの名前を入力します。

  3. [優先順位] ボックスの一覧で、[標準]、[低]、または [高] をクリックします。

  4. [追加] をクリックしてから [OK] をクリックします。

    [トークン一覧] にカスタム トークンを追加する方法の詳細については、「方法 : カスタム コメント トークンを作成する」を参照してください。

使用例

// The following C# code file contains several TODO reminders. 
// Note that each line task reminder begins, like this comment, 
//    with the C# comment indicator, '//'.

// TODO: Add standard code header comment here.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Windows.Forms;
// TODO: Add references to specific resources here.

namespace TodoExample
{
partial class TodoExample : Form
   {
      public TodoExample()
         {
            InitializeComponent();
         }
   }
}
// TODO: It is even possible to add comments at the end.

例が示すように、TODO コメントはコード ファイル内のどこにでも配置できます。[タスク一覧]のコメントは、コード内の特定の行またはセクションに対して実行する必要のある作業を示す場合に使用することが最適です。開発全般にかかわるタスクなど、長い説明にはあまり適していません。

参照

処理手順

方法 : コードにブックマークを設定する

方法 : タスク一覧を制御する

参照

タスク一覧 (Visual Studio)

XML コード コメントの追加

[ブックマーク] ウィンドウ

その他の技術情報

コードへのブックマークの設定