JUnit 5 Test Documentation
1. Inspect the Tests
- Read the target test classes before documenting them.
- Identify suite purpose, scenario intent, and major fixture patterns.
- Preserve existing naming conventions unless the task explicitly includes renaming.
2. Document What Matters
- Explain why the suite exists.
- Explain what behavior each test or nested group protects.
- Explain fixture or extension behavior only when it is not self-evident.
- Keep comments and documentation brief and maintainable.
3. Troubleshooting
- Problem: The tests are too opaque to document cleanly. Fix: Recommend structural cleanup instead of adding bloated comments.