jorsol commented on code in PR #33:
URL: https://github.com/apache/maven-archiver/pull/33#discussion_r1209467462


##########
src/main/java/org/apache/maven/archiver/MavenArchiveConfiguration.java:
##########
@@ -35,6 +35,10 @@ public class MavenArchiveConfiguration {
 
     private boolean recompressAddedZips = true;
 
+    /**
+     * @deprecated See <a 
href="https://bugs.openjdk.org/browse/JDK-8305597";>JDK-8305597</a>
+     */
+    @Deprecated

Review Comment:
   Well, adding Javadoc to private fields could be helpful in some cases, 
especially if the comment is succinct.
   
   Yet, even if adding a Javadoc on a private field is just a cosmetic change, 
it doesn't hurt in any way to have it, more when it signals to future 
developers that touch the code that the field should no longer be used for 
anything (or with extra care).
   
   I don't mind removing the Javadoc from the field, but there is no real need 
to remove it, in the end, is just a matter of code convention, just like adding 
Javadoc to a private method is valid.
   
   Maven plugins even recommend adding Javadoc on private fields as the 
documentation of `@Parameter` is generated from there.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@maven.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to