[Ctk-developers] Coding conventions

[Daniele Giunchi]

Dear All,

in Paolo's mail there is also the suggestion to use this "MAF compact
QA kit" written in python (we actually use it in MAF3) which can
monitoring file naming convention, class variables/methods naming
convention, presence of documentation,
comments percentage and so on (it can be extended with new "rules").
Obviously all the results can be published in html, and we'are
planning to extend it in order to create diagram of those quantities.
I think that it should increase quality and coherence of committed code.

best regards,
Daniele




On Thu, Apr 15, 2010 at 3:20 PM, Steve Pieper <pieper at bwh.harvard.edu> wrote:
> Hi Paolo -
>
> Excellent - thanks.
>
> We can also look at the slicer guidelines to get ideas:
>
> http://www.slicer.org/slicerWiki/index.php/Slicer3:Style
>
> Really the thing I feel strongly about is this statement:
>
>> All C++ classes must conform to the style conventions of their parent
>> classes.
>
> For pure CTK classes, I like the idea of promoting a 'best of the best'
> style guideline and the maf one looks good to me.
>
> Do other projects (MITK, DTK, etc) have style guideline pages we could look
> at?
>
> -Steve
>
>
>
> On Apr/15/10 8:24 AM, Quadrani Paolo wrote:
>>
>> Dear CTK developers,
>> as I saw that some code has been written and pushed to the Gti
>> repository made available from Steve Pieper, I would suggest to you all
>> to start thinking also at defining some *coding conventions*, so our
>> code will looks homogeneous and nice and clear to read / understand.
>>
>> In *MAF3* we have *defined some simple rules* to follow and you can
>> review them at this address: http://bit.ly/95k5rJ
>> If you like, I can propose to adopt them or we can start from them and
>> define the CTK coding conventions.
>>
>> According to those rules, we have already some python scripts that
>> automatically checks that all of those rules are respected in source
>> code written and committed in the repository.
>>
>> Attached you can find a couple of MAF3 classes (as example) that I wrote
>> for the framework.
>>
>> Cheers
>>
>> Paolo Quadrani
>> _________________________________
>> BioComputing Competence Centre
>> SCS s.r.l.
>>
>> Via Magnanelli 6/3, 40033
>> Casalecchio di Reno
>> Italy
>> http://bit.ly/9pqADE
>>
>>
>>
>>
>>
>>
>>
>>
>>
>>
>> _______________________________________________
>> Ctk-developers mailing list
>> Ctk-developers at commontk.org
>> http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers
>
> _______________________________________________
> Ctk-developers mailing list
> Ctk-developers at commontk.org
> http://public.kitware.com/cgi-bin/mailman/listinfo/ctk-developers
>