3 ms·
I am not impressed. These comments don't add much at all. There are some that superficially look OK and to add some knowledge but in practice are wrong. Then th
by PaulKeeble 3y ago
I am not impressed. These comments don't add much at all. There are some that superficially look OK and to add some knowledge but in practice are wrong. Then there is stuff like this that doesn't need to be there.
/**
* Returns the type of the artifact release.
* @return the type of the artifact release
*/
public String getType() {
return this.type;
}
But then you also have the following which looks reasonably promising and does contain useful information that you would only get from the code or the docs.
/**
* Constructs a new instance of AutoConfigurationMetadata.
*
* This method retrieves the inputs and sets the file path for the
* AutoConfiguration.imports file located in the
* META-INF/spring/org.springframework.boot.autoconfigure directory. The path
* sensitivity is set to RELATIVE and the property name is set to
* "org.springframework.boot.autoconfigure.AutoConfiguration".
*
* The method also sets a dependency on the processResources task name of the source
* set.
*
* Additionally, it creates a configuration named
* "AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME" if it does
* not already exist in the project's configurations.
*/
public AutoConfigurationMetadata() {
getInputs()
.file((Callable<File>) () -> new File(this.sourceSet.getOutput().getResourcesDir(),
@@ -68,19 +84,35 @@ public AutoConfigurationMetadata() {
.maybeCreate(AutoConfigurationPlugin.AUTO_CONFIGURATION_METADATA_CONFIGURATION_NAME);
}*