I've been reviewing the H2ConsoleAutoConfiguration class within the Spring Boot project and noticed that it could benefit from additional inline documentation to enhance readability and maintainability. While the code is generally clear, adding comments could help new contributors and users understand the purpose and functionality of this class more quickly.
I am willing to contribute to this documentation effort and would appreciate guidance on the preferred style and depth of comments from the project maintainers.
Comment From: wilkinsona
Thanks for the suggestion. We generally try to avoid comments, other than Javadoc on public API, as we find that they can quickly become out-of-date. Instead, we prefer to write code with short, meaningfully named, methods.
Looking at H2ConsoleAutoConfiguration specifically, it doesn't have any method-level javadoc comments as we don't consider an auto-configuration class's methods to be public API. The names and length of its methods also looks good to me with the longest being 12 lines.
Comment From: mbrnas
Hi, thanks for the reply, I did not know that you do not comment those types of methods on the public API, I apologize.