HTTP 404 on Oracle Java code conventions

Stephen Colebourne scolebourne at joda.org
Sun May 18 07:15:27 UTC 2014


On 17 May 2014 15:29, Phil Race <philip.race at oracle.com> wrote:
> The dead links need to be removed for sure and replaced with something else.
> However my understanding is that the positioning of the doc on the oracle
> website made it appear to be recommendations for the way all Java code
> should be written. Given that it doesn't cover newer features, and clearly
> Oracle isn't going to (or going to want to) enforce style guidelines for
> non-Oracle code it was deliberately removed.

Just noting that this statement is not true. Oracle is forcing style
guidelines on non-Oracle developers with the Javadoc doclint tool in
JDK 8. That tool is enforcing a very specific set of rules on Javadoc
that consist of a very particular style (one that is applicable for
the JDK itself, but not for others.) I would encourage Oracle project
management to review the doclint tool and its draconian default
settings which have broken numerous projects trying to upgrade to JDK
8.
http://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html
https://github.com/search?q=doclint&type=Issues

> However for projects in which Oracle *is* involved (ie openjdk) there
> seems to be a case for reviving this document in some limited form.
> ie limited in the material it covers to generally accepted and customary
> openjdk coding guidelines, and limited to claiming to be an openjdk
> document, but not a document for the entire world.

I think most developers recognise that coding guidelines are just
guidelines. If you feel you need to move them, then thats OK, but they
are a vital part of the ecosystem around any programming language,
Since the old link will be used around the web, a redirect would be
desirable.

Stephen

6/14 7:21 PM, Donald Smith wrote:
>>
>> There's a bug at [1] for that, suggest commenting there (I'll kick it
>> again now).
>> [1] https://bugs.openjdk.java.net/browse/JDK-8039151
>>
>> I'm not sure what it should say instead, but the linked pages seem to have
>> been removed.  Oddly, I do remember this guide from 1999 (15 years ago!!) --
>> and I believe it stopped being updated because that was right around the
>> time that IDEs started just automatically doing this for you, so the
>> conversations moved there.
>>
>>  - Don
>>
>> On 16/05/2014 8:26 PM, Radov, Nicholas O wrote:
>>>
>>> I'm posting this on the discuss list in the hope that someone at Oracle
>>> will see it and take action. All of the links on the "Code Conventions for
>>> the Java Programming Language" web page are broken.
>>>
>>> http://www.oracle.com/technetwork/java/index-135089.html
>>>
>>> This e-mail, including attachments, may include confidential and/or
>>> proprietary information, and may be used only by the person or entity
>>> to which it is addressed. If the reader of this e-mail is not the
>>> intended
>>> recipient or his or her authorized agent, the reader is hereby notified
>>> that any dissemination, distribution or copying of this e-mail is
>>> prohibited. If you have received this e-mail in error, please notify the
>>> sender by replying to this message and delete this e-mail immediately.
>>
>>
>



More information about the discuss mailing list