ソースにリンクしたデバッグ出力をおこなう

(2016/12/03 0:10:24 created.)

System.Diagnostics.Debug クラスや System.Diagnostics.Trace クラスを使用することで出力ウィンドウに文字列を出力することができます。このとき、次のような書式で出力をおこなうことで、出力されたテキストをダブルクリックすると該当するソースコードにジャンプすることができるようになります。

Program.cs

```
namespace Tips_DebugTrace
```
```
{
```
```
    using System.Diagnostics;
```

    using System.Runtime.CompilerServices;

```
 
```
```
    class Program
```
```
    {
```
```
        static void Main(string[] args)
```
```
        {
```

            WriteLine("アプリケーションが起動しました。");

```
 
```
```
            Task();
```
```
 
```
```
            System.Console.ReadKey();
```
```
        }
```
```
 
```
```
        static void Task()
```
```
        {
```

            WriteLine("Task メソッドが実行されました。");

```
        }
```
```
 
```
```
        /// <summary>
```

        /// デバッグ出力をおこないます。

```
        /// </summary>
```

        /// <param name="message">出力するメッセージを指定します。</param>

        /// <param name="name">メソッド名を指定します。</param>

        /// <param name="filePath">ソースファイルのフルパスを指定します。</param>

        /// <param name="lineNumber">行番号を指定します。</param>

```
        [Conditional("DEBUG")]
```

        static void WriteLine(string message, [CallerMemberName]string name = null, [CallerFilePath]string filePath = null, [CallerLineNumber]int lineNumber = 0)

```
        {
```

            var str = string.Format("{0}({1}) :{2} {3}", filePath, lineNumber, name != null ? " [" + name + "]" : "", message);

            System.Diagnostics.Debug.WriteLine(str);

```
        }
```
```
    }
```
```
}
```

重要なのは始めにファイルのフルパス、続いて "("、")" の括弧で括った行番号となっていることです。このようなメッセージの場合、ダブルクリックすると該当するソースファイルが開き、該当する行番号にカーソルがジャンプするようになります。上記の例では呼び出し元のメソッド名も同時に表示することでさらに分かりやすくしています。

また、VSColorOutput などの拡張機能によって出力ウィンドウに表示されるテキストに色を付けている場合、Information や Error といったキーワードを含むことでさらにわかりやすいメッセージとなります。