Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [incubation] Project Release Coding Style

Hi,

Code styling is important, but getting to a consensus on what is good/bad is as close as religious war as you can get. At the end what matters is consistency. What ever you decide as your coding standards (indentation, line wrap, opening brackets location, etc) just make sure it's consistent.

My two cents, and what IMHO is most important, is documentation. If you really want your project to be opened sourced and to get people contributing and helping out, more than having nice styled code, having proper documentation is best.

Cheers.

On 18 Jun 2016 8:53 a.m., "Philip Wenig" <philip.wenig@xxxxxxxxxxxxx> wrote:
We also enforce developers to use the coding styles, which are stored in one of our Git repositories.
https://wiki.openchrom.net/index.php/Development#Edit_settings

Anyhow, it sometimes happens that people forget to format the code. The Java editor offers an auto-format capability which is quite nice.


Cheers,
Philip

Am 17.06.2016 um 20:56 schrieb Sam Davis:
You can configure the Java Editor to perform auto-actions on save, potentially on a per-project basis. I have never enabled it on my code because I have never adjusted formatting styles to match my longer line wrapping preferences.

Some projects, notably EMF, have very esoteric code styles which I find that I always need to emulate by hand.

Note that if code formatting is configured on a per-project basis, this configuration is stored in git so that anyone checking out the project and using Eclipse will automatically check in correctly formatted code. This is how we do it in Mylyn and it means we don't have code formatting as a part of our release process - all the code is already always correctly formatted.

Cheers,
Sam


_______________________________________________
incubation mailing list
incubation@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation

-- 
~~~~~~~~~~~~~~~~~~~~~~~~
OpenChrom - the open source alternative for chromatography / mass spectrometry
Dr. Philip Wenig » Founder » philip.wenig@xxxxxxxxxxxxx » http://www.openchrom.net
~~~~~~~~~~~~~~~~~~~~~~~~

_______________________________________________
incubation mailing list
incubation@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/incubation


Back to the top