RFR: 8330178: Clean up non-standard use of /** comments in `java.base`

Alexey Ivanov aivanov at openjdk.org
Fri Apr 19 19:32:58 UTC 2024


On Fri, 19 Apr 2024 19:18:31 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> We do not have an overall style guide. The conventional wisdom for editing any existing file is to follow the style in that file, if such a style can be discerned.

That's what I do.

I saw either style used in JDK. Yet I didn't check which style is more common… to decide which style I should use when creating new files with javadoc comments. [How to Write Doc Comments for the Javadoc Tool](https://www.oracle.com/uk/technical-resources/articles/java/javadoc-tool.html) doesn't have a blank line between the javadoc comment and class declaration; nor do javadoc comments for fields and methods.

-------------

PR Comment: https://git.openjdk.org/jdk/pull/18846#issuecomment-2067169319


More information about the core-libs-dev mailing list