はじめに
今回はRiderの拡張機能であるXML Doc Inspectionsについて紹介したいと思います。
A simple ReSharper extension which enables to show warnings for missing XML Doc comments for types and type members. In contrast to the C# compiler's CS1591 warning which emits a warning for all public or protected types and members, this extension provides configuration options. Further it comes with a quick fix action to generate doc comment templates.
// DeepL翻訳
ReSharperのシンプルな拡張機能で、型と型メンバーのXML Docコメントの欠落に対する警告を表示することができます。C#コンパイラのCS1591警告がすべてのpublicまたはprotected型とメンバーに対して警告を出すのとは対照的に、この拡張機能は設定オプションを提供します。さらに、docコメントテンプレートを生成するクイックフィクスアクションが付属しています。
GitHub - ulrichb/XmlDocInspections: Configurable XML Doc warnings for ReSharper
この拡張機能を導入することで、XML Doc commentを書いていない場合に警告を出す・出さないの範囲を指定することができます。
(例. PrivateメソッドにもXML Doc commentを書くように警告を出す)
また補足ではありますがXML Doc commentは以下のような奴のことですね。
/// <summary> /// PublicなMethodです /// </summary> public void PublicMethod() {}
インストール
メニューバーよりFile -> Settings...を選択しSettingsウィンドウを立ち上げます。
サイドバーのPluginsを選択しXML Doc Inspectionsを検索、インストールをします。
使い方
SettingsウィンドウのEditor -> Inspection Settings -> XML Doc Inspectionより警告を出す適応範囲を設定することができます。
The following rules are applied when warning about missing XML Doc comments. Note that the severity level for the warning can be configured on the "Inspection Severity" page.
// DeepL翻訳
XML Docコメントの欠落を警告する場合、以下のルールが適用されます。なお、警告の厳しさは、「検査の厳しさ」ページで設定することができます。
実験
デフォルト設定ではTypesがpubilc, protected internal, protectedのときに警告が出てきます。
次にXML Doc Inspectionsにてprivateにチェックを入れて試してみましょう。
するとprivateなメソッドにも警告が出てくるようになったのが確認できます。
