JWT007 commented on code in PR #3505:
URL: https://github.com/apache/logging-log4j2/pull/3505#discussion_r1974471071
##########
log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/impl/DefaultComponentBuilder.java:
##########
@@ -57,43 +59,51 @@ public DefaultComponentBuilder(final CB builder, final
String name, final String
this.value = value;
}
+ /** {@inheritDoc} */
Review Comment:
oh I guess I just do that as a matter of course... I asked my AI Assistant -
best practice, etc. :)
- Including `/** {@inheritDoc} */` as a rule for all overridden methods
ensures that all methods are documented in the same manner, even if no
additional details are needed.
- This can be particularly useful in libraries used by others (e.g.,
open-source or enterprise frameworks) where clear documentation is critical.
- If you're building a library or public-facing tool, adding
`{@inheritDoc}` for every method provides clarity when generating documentation
and ensures consistency
- Adding `/** {@inheritDoc} */` to methods that don't add any documentation
is often considered a **good practice for clarity**, especially for public APIs
or widely used libraries.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
