- The first sentence must be in a dedicated paragraph separated from the rest of the text. This will make the - description easier to read. - Make sure the description doesn’t just repeat the inspection title. -
+Reports missing or improperly formatted unit test annotations and documentation in JUnit test methods. +- See https://plugins.jetbrains.com/docs/intellij/inspections.html#descriptions for more information. + This inspection verifies that test methods have proper test case management annotations and contain both step and assert comments + to document test behavior. It helps maintain consistent test documentation and improves test maintainability.
+- Embed code snippets: + The inspection checks for: +
Example of a properly documented test method:
-// automatically highlighted according to inspection registration 'language' attribute
+@Test
+@TestCaseAnnotation
+public void testFeature() {
+ // Step: Initialize test data
+ String input = "test";
+
+ // Step: Execute the method under test
+ String result = feature.process(input);
+
+ // Assert: Verify the expected outcome
+ assertEquals("expected", result);
+}
Text after this comment will only be shown in the settings of the inspection.
-To open related settings directly from the description, add a link with `settings://$` optionally followed by `?$` to - pre-select a UI element.
+ ++ Configure annotation schemas and requirements in Settings | Editor | Unittest Annotation Configuration. +
\ No newline at end of file