RFR: Updated section on Code Conventions. [v4]

Jesper Wilhelmsson jwilhelm at openjdk.java.net
Thu Jun 25 15:28:56 UTC 2020


On Thu, 25 Jun 2020 08:13:46 GMT, Andreas Lundblad <github.com+5994243+aioobe at openjdk.org> wrote:

>> src/javaStyleGuide.md line 1366:
>> 
>>> 1365: - IDE/tool-specific comments should be avoided wherever possible, especially when there are reasonable
>>> alternatives, such as external settings files, etc. 1366: - Comments should be grammatically correct and follow general
>>> recommendations of technical writing. 1367: :::
>> 
>> The three Javadoc lines can be added at the end here and the examples below. Then have the link to the complete guide
>> in a "For more information..."-link.
>
> Not 100% sure I understood. Let me know what you think about the latest version.

This is exactly what I wanted ��

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

PR: https://git.openjdk.java.net/guide/pull/14


More information about the guide-dev mailing list