[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [tracecompass-dev] Code style adendum
|
After wednesday, I would love to. It drives me nuts to lose time on
variable names and such. ;)
On 15-08-31 12:21 PM, Alexandre Montplaisir wrote:
> Makes sense.
>
> Would you like to write a page on the wiki documenting the coding
> style? :)
>
> Alex
>
> On 2015-08-31 10:13 AM, Matthew Khouzam wrote:
>> Hi all, I want to propose an adendum to our coding style.
>>
>> https://msdn.microsoft.com/en-us/library/141e06ef%28v=vs.71%29.aspx
>>
>> Slightly adapted, of course.
>>
>> I propose for naming methods and fields:
>>
>> * Do not shorten words: so getCurentDisplay and not getCurrDisplay
>>
>> * Do not use acronyms, unless you have to (getSipie == bad) and it
>> exists outside the bounds of Tracecompass.
>>
>> * When using an acronym, 2 chars == UPPERCASE, 3+chars = lowercase. So
>> IOException = yes, CPUException becomes CpuException.
>>
>> An interesting exception is ID, as the noun ID is uppercase, getID is
>> acceptable, getId is less. getId would be acceptable for psychology
>> software though.
>>
>>
>> Thoughts?
>> _______________________________________________
>> tracecompass-dev mailing list
>> tracecompass-dev@xxxxxxxxxxx
>> To change your delivery options, retrieve your password, or
>> unsubscribe from this list, visit
>> https://dev.eclipse.org/mailman/listinfo/tracecompass-dev
>
