IntelliJ如何通过注解标记自定义String.format类方法实现格式化高亮

你需要使用JetBrains官方提供的@FormatMethod注解即可实现需求，具体操作如下：

• 若项目还未引入JetBrains注解库，先添加对应依赖：
  Maven项目在pom.xml中添加：

  <dependency>
      <groupId>org.jetbrains</groupId>
      <artifactId>annotations</artifactId>
      <version>24.1.0</version>
      <scope>compile</scope>
  </dependency>
  

  Gradle项目在build.gradle中添加：

  dependencies {
      compileOnly 'org.jetbrains:annotations:24.1.0'
  }
  

• 在你封装的execute方法上添加@org.jetbrains.annotations.FormatMethod注解
• 需保证你的方法参数结构和String.format一致：第一个参数为格式字符串，后续参数为格式串占位符对应的入参

注解添加完成后，IntelliJ会自动识别该方法为标准格式化方法，自动启用格式串高亮、占位符校验、参数匹配提示等所有原生String.format具备的IDE特性，所有团队成员无需做任何手动配置即可生效。

内容的提问来源于stack exchange，提问作者Erwan Daniel