Rich PHPDoc for the Rule interface

phpstan · Mar 24, 2023 · 23d29ab · 23d29ab
1 parent d6d9ef7
commit 23d29ab
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/Rules/Rule.php b/src/Rules/Rule.php
@@ -6,6 +6,19 @@
 use PHPStan\Analyser\Scope;
 
 /**
+ * This is the interface custom rules implement. To register it in the configuration file
+ * use the `phpstan.rules.rule` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\MyRule
+ *		tags:
+ *			- phpstan.rules.rule
+ * ```
+ *
+ * Learn more: https://phpstan.org/developing-extensions/rules
+ *
  * @api
  * @phpstan-template TNodeType of Node
  */