Add comment to method declarations
Recipe ID
org.openrewrite.java.AddCommentToMethodArtifact
org.openrewrite:rewrite-javaAdd a comment to method declarations in a Java source file.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.AddCommentToMethod --recipe-option "comment=This is a comment." --recipe-option "methodPattern=java.util.List add*(..)"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-java:8.88.0Options
| Name | Type | Description |
|---|---|---|
commentrequired | String | The comment to add. e.g. This is a comment. |
methodPatternrequired | String | A pattern to match methods to add the comment to. A method pattern is used to find matching method declarations. For example, to find all method declarations in the Guava library, use the pattern: com.google.common..*#*(..).The pattern format is <PACKAGE>#<METHOD_NAME>(<ARGS>). ..* includes all subpackages of com.google.common. *(..) matches any method name with any number of arguments. For more specific queries, like Guava's ImmutableMap, use com.google.common.collect.ImmutableMap#*(..) to narrow down the results.e.g. java.util.List add*(..) |
isMultiline | Boolean | Comments use by default single line // but they can use multiline /* */. |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats