RiderのTODOリストを使ってコードの要修正箇所を管理する

Riderの環境構築

JetBrains Rider の環境構築手順は以下を参照ください。
bluebirdofoz.hatenablog.com

TODOリスト

RiderのTODOリストはコード内の残タスクや技術的負債など後から修正が必要な個所を追跡する機能です。
コード内に特定パターンのコメントや識別子を利用することでソリューション全体から該当箇所を簡単に見つけることができます。
pleiades.io

デフォルトでは以下のタイプのパターンを利用できます。

TODO を含むコメント - 標準
BUG を含むコメント - エラー
コード内の NotImplementedException - 編集

サンプルコード

コード内にTODOとして判定されるコメントやコードを含む以下のようなサンプルコードを用意しました。
・SpatialMapTrackingPointCheck

public class SpatialMapTrackingPointCheck : MonoBehaviour
{
    // --- (略) ---

    /// <summary>
    /// カメラから一定距離になるように位置を更新する
    /// </summary>
    private void UpdateTransformFromCamera()
    {
        // TODO カメラからの距離上限を変更できるようにする
        const float modelSetDistance = 3.0f;
        
        // --- (略) ---

        if (Physics.Raycast(camPosition, camTransform.forward, out var hit, modelSetDistance))
        {
            targetPosition = hit.point;
            // BUG メッシュレイヤーを正しく判定できない
            if (hit.collider.gameObject.layer == meshPhysicsLayer)
        
        // --- (略) ---
        
        // 衝突したオブジェクトの種類によって色を変える
        _renderer.material.color = hitType switch
        {
            HitType.Nothing => Color.white,
            HitType.SpatialMap => Color.red,
            HitType.Other => Color.green,
            // 不明な種別が来た場合は例外を投げる
            _ => throw new NotImplementedException()
        };

        // --- (略) ---

メニューから[表示 -> ツールウィンドウ -> TODO]を選択するか、ショートカットキー Ctrl + \ -> t キーを押下します。

これでTODOウィンドウが開きます。ソリューション内のパターンを含むコード個所が確認できます。

検出されたコードをダブルクリックすることでコードの該当箇所を開くことができます。