[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [equinox-dev] Equinox coding conventions


Great!  Thanks Tom.  Can someone do this for the provisioning projects as well?  Some of them have the some of the right settings but it would be good to have a complete pass over them to ensure consistency etc.

Jeff



Thomas Watson <tjwatson@xxxxxxxxxx>
Sent by: equinox-dev-bounces@xxxxxxxxxxx

08/21/2007 12:55 PM

Please respond to
Equinox development mailing list <equinox-dev@xxxxxxxxxxx>

To
Equinox development mailing list <equinox-dev@xxxxxxxxxxx>
cc
Subject
Re: [equinox-dev] Equinox coding conventions






I updated the following equinox projects to have the latest Equinox code convention settings.  I also updated each project to format java files when saving.  You may notice additional changes when saving java files and creating patches.  In this case the code was probably not correctly formatted.


org.eclipse.equinox.app

org.eclipse.equinox.common

org.eclipse.equinox.device

org.eclipse.equinox.event

org.eclipse.equinox.http

org.eclipse.equinox.http.jetty

org.eclipse.equinox.http.registry

org.eclipse.equinox.http.servlet

org.eclipse.equinox.http.servletbridge

org.eclipse.equinox.jsp.jasper

org.eclipse.equinox.jsp.jasper.registry

org.eclipse.equinox.launcher

org.eclipse.equinox.log

org.eclipse.equinox.metatype

org.eclipse.equinox.preferences

org.eclipse.equinox.registry

org.eclipse.equinox.servletbridge

org.eclipse.equinox.supplement

org.eclipse.equinox.useradmin

org.eclipse.osgi


Because of bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=200207 the org.eclipse.osgi project cannot set the "Malformed Javadoc" compiler settings to "Error".  All other projects do have this set to "Error".


Tom



John Arthorne <John_Arthorne@xxxxxxxxxx>
Sent by: equinox-dev-bounces@xxxxxxxxxxx

08/20/2007 04:35 PM

Please respond to
Equinox development mailing list <equinox-dev@xxxxxxxxxxx>

To
equinox-dev@xxxxxxxxxxx
cc
Subject
[equinox-dev] Equinox coding conventions








As more and more people are contributing to Equinox (Thanks!) we thought it would make sense to point out the Equinox coding conventions:


http://www.eclipse.org/equinox/documents/coding.php

In some ways these sort of guidelines can show up as restricting one's freedom of artistic code formatting or variable naming _expression_. In practice however, having a common set of coding practices is one of the ingredients of our success. We have a large and growing body of committers in Equinox, and a much larger community looking in and trying to understand what we write.  Having common and consistent conventions makes our code easier to read and work with for everyone.

In particular, check out the section around formatter and compiler settings. These we should setup in each project so that everyone is seeing the same errors and formatting the same way. We're also going to experiment with enabling automatic formatting and code cleanup on save, so we can just forget about these issues and let the tools do the work.
_______________________________________________
equinox-dev mailing list
equinox-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/equinox-dev

_______________________________________________
equinox-dev mailing list
equinox-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/equinox-dev