Re: [triquetrum-dev] code formatting standards

["Torkild U. Resheim" <torkildr@xxxxxxxxx>]

While I’m at it. If you’re using Mylyn Tasks (which you should) you can also set "task repository" and «commit template» per project. Any «bug 1234» comments in the code will correctly link to the issue entry. I tend to use such comments in relation to regression tests. Setting the «commit template» helps ensure that everyone uses the same format. Also, since Triquetrum is on GitHub one could use this to have the issue automatically closed when the pull request is merged into master. I typically use this format for GitHub:

Fix #${task.key}: ${task.description} 

Task-Url: ${task.url}

Best regards,
Torkild

> 16. jun. 2016 kl. 22.00 skrev Jonah Graham <jonah@xxxxxxxxxxxxxxxx>:
> 
> +1 on storing the settings in the project. I will be doing that for
> the AnalysisRPC plug-ins I am working on at the moment.
> 
> Jonah
> ~~~
> Jonah Graham
> Kichwa Coders Ltd.
> www.kichwacoders.com
> 
> 
> On 16 June 2016 at 20:03, Torkild U. Resheim <torkildr@xxxxxxxxx> wrote:
>> I’m not a committer on this project, but I I’m taking the chance to utter my
>> opinion anyway :) I think what Christopher says is a good idea; use the
>> default Eclipse coding style with longer lines. Also it’s a good idea to
>> store these settings per project (can be enabled through "project properties
>>> Java Code Style > Formatter». This way the settings can be versioned
>> (.settings/org.eclipse.jdt.ui.prefs) and shared between developers. Also the
>> «Context menu > Source > Format» action and equivalent will use these
>> settings, so if you’re unsure that you got it right, just format the code
>> you’ve edited. Or even set a save action to automatically format edited
>> code.
>> 
>> Best regards,
>> Torkild
>> 
>> 
>> 16. jun. 2016 kl. 17.53 skrev Christopher Brooks <cxh@xxxxxxxxxxxxxxxxx>:
>> 
>> I think we should probably follow the Eclipse coding style, which is 4
>> spaces for indentation.
>> 
>> As part of the release, we should clean the code, see
>> https://github.com/eclipse/triquetrum/issues/79
>> 
>> I had assumed that part of this would be to use Eclipse to clean the code
>> using the Eclipse style formatter.
>> 
>> Longer lines are OK with me.
>> 
>> As a matter of personal preference, I prefer CamelCase names over names that
>> have abbreviations (CmlCs).  However, we need not enforce that.
>> 
>> I also prefer that code be well commented.  A lot of open source code has no
>> comments and is very difficult to reuse.
>> 
>> _Christopher
>> 
>> 
>> 
>> 
>> On 6/16/16 6:49 AM, Erwin de Ley wrote:
>> 
>> Hi Jonah,
>> 
>> I have attached the exported prefs from the Java/Code Style/Formatter
>> preferences.
>> 
>> The main things :
>> 
>> - indentations are 2 spaces, no TABs
>> 
>> - longer lines (160 chars)
>> 
>> cheers
>> 
>> erwin
>> 
>> Op 16/06/2016 om 15:35 schreef Jonah Graham:
>> 
>> Hi Erwin,
>> 
>> Are there code formatting standards for Triq?
>> 
>> Thanks
>> Jonah
>> 
>> ~~~
>> Jonah Graham
>> Kichwa Coders Ltd.
>> www.kichwacoders.com
>> _______________________________________________
>> triquetrum-dev mailing list
>> triquetrum-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from
>> this list, visit
>> https://dev.eclipse.org/mailman/listinfo/triquetrum-dev
>> 
>> 
>> 
>> 
>> 
>> _______________________________________________
>> triquetrum-dev mailing list
>> triquetrum-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from
>> this list, visit
>> https://dev.eclipse.org/mailman/listinfo/triquetrum-dev
>> 
>> 
>> --
>> Christopher Brooks, PMP                       University of California
>> Academic Program Manager & Software Engineer  US Mail: 337 Cory Hall
>> CHESS/iCyPhy/Ptolemy/TerraSwarm               Berkeley, CA 94720-1774
>> cxh@xxxxxxxxxxxxxxxxx, 707.332.0670           (Office: 545Q Cory)
>> 
>> _______________________________________________
>> triquetrum-dev mailing list
>> triquetrum-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from
>> this list, visit
>> https://dev.eclipse.org/mailman/listinfo/triquetrum-dev
>> 
>> 
>> 
>> _______________________________________________
>> triquetrum-dev mailing list
>> triquetrum-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or unsubscribe from
>> this list, visit
>> https://dev.eclipse.org/mailman/listinfo/triquetrum-dev
>> 
> _______________________________________________
> triquetrum-dev mailing list
> triquetrum-dev@xxxxxxxxxxx
> To change your delivery options, retrieve your password, or unsubscribe from this list, visit
> https://dev.eclipse.org/mailman/listinfo/triquetrum-dev