より良いエンジニアを目指して

1日1つ。良くなる!上手くなる!

Resharperでinheritdocタグを挿入する

docs.microsoft.com

C#のコメントにはinheritdocタグが存在します。

たとえば以下のようなコード。

using System;

namespace ConsoleApp1
{
    interface ITest
    {
        /// <summary>
        /// 何かの取得処理です。
        /// </summary>
        public string Get();
    }

    class Test : ITest
    {
        /// <inheritdoc />
        public string Get() => "test";
    }
}

ITest.Getメソッドを実装したTestクラスのGetメソッドはpublicなメソッドなのでコメントを記載すべきです。

そこでコピペコメントにしてしまうと、保守性が悪いです。

コメントを修正したい場合はどちらも修正しなければなりません。

そこでを指定します。

しかし、このタグですが長いです。

以前私は、うっかり勘違いして<inheritdocs />と誤字で入力してました。

なのでResharperを使っている場合は、コード支援機能に委ねた方が良いです。

以下の操作を実行します。

  1. メソッド名でAlt + Enter
  2. Copy documentation from base
  3. add <inheritdoc />

f:id:rimever:20200514201835p:plain