Code Conventions

Jesper Wilhelmsson jesper.wilhelmsson at oracle.com
Fri Feb 7 16:09:19 UTC 2020


Once the project is proposed at announce at openjdk.java.net <mailto:announce at openjdk.java.net> there will be a vote and from there the discussion will be in the public mailing lists. Provided the project is accepted a mailing list for it will be created and then the work begins :-)

A big leap forward in this work was taken earlier this week and I'm currently waiting for the dust to settle after JFocus before having internal discussions with the current owners of the guide.
/Jesper


> On 7 Feb 2020, at 16:55, Lars Francke <lars.francke at gmail.com> wrote:
> 
> Excellent! That'd be great.
> I'd be happy to follow along and contribute if needed/possible. What would be the best place for me to follow your project (or the road to your project)?
> 
> On Fri, Feb 7, 2020 at 4:53 PM Jesper Wilhelmsson <jesper.wilhelmsson at oracle.com <mailto:jesper.wilhelmsson at oracle.com>> wrote:
> I have recently started to dig into The OpenJDK Developer's Guide. My goal is to have an OpenJDK project for the guide and start to add the missing information there. There is a section for code conventions in the guide. I think that once we have the project in place, that is the place to have a discussion around code conventions and finally have an updated version published in the guide.
> 
> /Jesper
> 
> > On 7 Feb 2020, at 10:31, Lars Francke <lars.francke at gmail.com <mailto:lars.francke at gmail.com>> wrote:
> >
> > This is an old thread but it's still relevant.
> >
> > Is there any chance we can get Andreas' version published? It's been a
> > DRAFT for years, there have been multiple discussions and I think he
> > distilled most of them down into his current document.
> >
> > We can obviously keep discussing but there will always be differing
> > opinions and we'll never update the old conventions.
> >
> > On Thu, Apr 11, 2019 at 3:47 PM Andreas Lundblad <andreas.lundblad at gmail.com <mailto:andreas.lundblad at gmail.com>>
> > wrote:
> >
> >> That page has said "This section will contain a major revision of our
> >> antiquated code conventions" like forever. We came far with that major
> >> revision a couple of years ago. Latest draft available here:
> >>
> >> http://cr.openjdk.java.net/~alundblad/styleguide/index-v6.html <http://cr.openjdk.java.net/~alundblad/styleguide/index-v6.html>
> >>
> >> I even have a version adapted to openjdk.java.net <http://openjdk.java.net/> formatting.
> >>
> >> I suggest we take this over the finish line and get it published properly.
> >> I
> >> happen to have time to spare the coming weeks and am happy to contribute.
> >>
> >> -- Andreas
> >>
> >> On Thu, Apr 11, 2019 at 5:47 AM Dalibor Topic <dalibor.topic at oracle.com <mailto:dalibor.topic at oracle.com>>
> >> wrote:
> >>
> >>> On 22.03.2019 17:13, Jean-Claude Arbaut wrote:
> >>>> https://www.oracle.com/technetwork/java/codeconvtoc-136057.html <https://www.oracle.com/technetwork/java/codeconvtoc-136057.html>
> >>>
> >>> Merci Jean-Claude,
> >>>
> >>> I updated the link accordingly.
> >>>
> >>> cheers,
> >>> dalibor topic
> >>>
> >>>> Le jeu. 21 mars 2019 à 11:33, Florian Weimer <fw at deneb.enyo.de <mailto:fw at deneb.enyo.de>> a
> >> écrit
> >>> :
> >>>>
> >>>>> This page
> >>>>>
> >>>>>   <http://openjdk.java.net/guide/codeConventions.html <http://openjdk.java.net/guide/codeConventions.html>>
> >>>>>
> >>>>> contains only a dead link to:
> >>>>>
> >>>>>   <http://java.sun.com/docs/codeconv/index.html <http://java.sun.com/docs/codeconv/index.html>>
> >>>>>
> >>>>> Is this page archived somewhere?
> >>>>>
> >>>>> Right now, I'm particularly interested in formatting guidelines for
> >>>>> exception messages.  Should they begin with a capitable letter?  Are
> >>>>> there rules for producing certain clipped sentences?  (Such a rule
> >>>>> appears to exist for the first sentence in a method documentation.)
> >>>>>
> >>>
> >>> --
> >>> Oracle <http://www.oracle.com <http://www.oracle.com/>>
> >>> Dalibor Topic | Principal Product Manager
> >>> Phone: +494089091214 <tel:+494089091214> | Mobile: +491737185961
> >>> <tel:+491737185961>
> >>>
> >>> ORACLE Deutschland B.V. & Co. KG | Kühnehöfe 5 | D-22761 Hamburg
> >>>
> >>> ORACLE Deutschland B.V. & Co. KG
> >>> Hauptverwaltung: Riesstr. 25, D-80992 München
> >>> Registergericht: Amtsgericht München, HRA 95603
> >>>
> >>> Komplementärin: ORACLE Deutschland Verwaltung B.V.
> >>> Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
> >>> Handelsregister der Handelskammer Midden-Nederland, Nr. 30143697
> >>> Geschäftsführer: Alexander van der Ven, Jan Schultheiss, Val Maher
> >>>
> >>> Green Oracle <http://www.oracle.com/commitment <http://www.oracle.com/commitment>> Oracle is committed to
> >>> developing practices and products that help protect the environment
> >>>
> >>
> 



More information about the discuss mailing list