JUnit 5 并未提供 @Description 注解（该注解属于 JDK Flight Recorder，与测试无关），真正可用的标准化方案是 @DisplayName；若需更丰富的场景化描述（如 Given-When-Then 风格），可通过自定义 DisplayNameGenerator 或结合 Javadoc + IDE 插件实现。
junit 5 并未提供 `@description` 注解（该注解属于 jdk flight recorder，与测试无关），真正可用的标准化方案是 `@displayname`；若需更丰富的场景化描述（如 given-when-then 风格），可通过自定义 `displaynamegenerator` 或结合 javadoc + ide 插件实现。
在 JUnit 5 中，开发者常误以为存在类似 @Description 的注解用于补充测试语义（例如描述业务场景、前置条件或验证逻辑），但事实是：org.junit.jupiter.api.Description 并不存在——这是常见误解，甚至部分 AI 工具会错误生成该注解。你实际使用的 @jdk.jfr.Description 属于 JDK 性能诊断工具链（JFR），仅用于事件元数据标记，对测试执行、IDE 显示或报告输出完全无影响。
✅ 正确做法：使用 @DisplayName
这是 JUnit 5 官方支持的、最轻量且广泛兼容的方式：
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
@DisplayName("Dog 对象相等性校验")
class DogTest {
@Test
@DisplayName("当两只狗名字和体重相同时，应判定为相等")
void testComparisonOfDogObjects() {
Dog dog = new Dog("Fido", 5.25f);
Dog dogClone = new Dog("Fido", 5.25f);
assertEquals(dog, dogClone);
}
}
运行后，IntelliJ IDEA、Maven Surefire 报告及 Gradle 测试面板均会显示 "当两只狗名字和体重相同时，应判定为相等" 而非默认方法名 testComparisonOfDogObjects，显著提升可读性。
? 进阶方案：自定义 DisplayNameGenerator（支持 Given-When-Then）
若需结构化描述（如 BDD 风格），可实现 DisplayNameGenerator：
public class GwtDisplayNameGenerator implements DisplayNameGenerator.Replaceable {
@Override
public String generateDisplayNameForClass(Class> testClass) {
return testClass.getSimpleName();
}
@Override
public String generateDisplayNameForMethod(Class> testClass, Method testMethod) {
String name = testMethod.getName();
// 约定：方法名以 "given_" "when_" "then_" 开头
if (name.startsWith("given_")) return "Given " + name.substring(6);
if (name.startsWith("when_")) return "When " + name.substring(5);
if (name.startsWith("then_")) return "Then " + name.substring(5);
return name;
}
}
并在测试类上声明：
@DisplayNameGeneration(GwtDisplayNameGenerator.class)
class DogTest { /* ... */ }
此时方法 given_dog_with_same_name_and_weight() 将显示为 "Given dog with same name and weight"。
⚠️ 注意事项：
- 不要混用 JUnit 4 的 org.junit.runner.Description —— 它仅用于 @RunWith 场景，与 JUnit 5 不兼容；
- Javadoc 注释虽能文档化测试意图，但不会动态渲染到 IDE 运行器或 HTML 报告中（除非配合插件如 JUnit Report 或自定义扩展）；
- Maven 依赖中无需额外引入 junit-platform-surefire-provider（JUnit 5.9+ 已内置支持），建议精简为标准三件套：
<dependency><groupid>org.junit.jupiter</groupid><artifactid>junit-jupiter</artifactid><version>5.10.3</version><scope>test</scope></dependency>
总结：@DisplayName 是 JUnit 5 中唯一开箱即用、全环境生效的“描述性标签”机制；所谓 @Description 是认知误区。追求更高表达力时，优先通过命名规范 + DisplayNameGenerator 实现，而非寻找不存在的注解——这既是最佳实践，也是框架设计的本意。
