elementary-dev-community team mailing list archive

[Avi Romanoff <avi@xxxxxxxxxxxxxxxx>]

I agree with Christian's comments -- we're writing in Vala, if anything, we
should be strongly encouraging the existing styles.

Also, have we considered the existing style documentation we drafted a
while ago? (I think it might still be internal for whatever reason, so I'll
post it here:

Coding Style

   - Indentation is done using 4 spaces. *not tabs.*
   - Between 80 to 120 characters per line
   - Cuddled else
   - Hanging curly brackets
   - snake_case for methods and variables
   - Class names are PascalCase
   - SCREAMING_CAPS for enumerations and constants
   - No hungarian notation
   - C-style multi-line comments
   - Spaces between expression or function name and opening brackets
   - Explicit namespaces, no using


I also drafted some similar guidelines about function styles, but this was
before the contributor meetings were implemented so it was basically
impossible to come to a rational/reasonable conclusion within the council
(since the council has basically no reason or motivation to make sweeping
style-guides -- that obviously should happen bottom-up from the developers
themselves).

How about we merge/link the existing drafts and bring this up at the next
contributor meeting?

Avi

On Mon, Jan 2, 2012 at 2:56 PM, Scott Ringwelski <sgringwe@xxxxxxx> wrote:

> I prefer something like this:
>
> public int my_function(string var) {
>     int rv = 0; // var declarations
>
>     // code
>
>     return rv; // return has empty line before it.
> }
>
> to call it:
> var result = my_function("hi");
>
> Having an empty line after the function declaration looks really odd to
> me. I also prefer not space between the function name and params.
>
> What about function comments? I think function comments aren't really
> necessary, except for the especially important ones or common ly used ones.
>
> On Mon, Jan 2, 2012 at 11:19 AM, David Gomes <davidrafagomes@xxxxxxxxx>wrote:
>
>> Ideally, for me, I'd love:
>>
>> public int my_function ()
>> {
>>   //Code
>> }
>>
>> It's the best way because the parentheses are aligned, so I can see where
>> the function starts and where it ends.
>>
>> However, I know most of you don't like it, we'll have to choose between
>> these: (notice the empty line difference)
>>
>> void my_function () {
>>
>>   //Code
>> }
>>
>> void my_function () {
>>   //Code
>> }
>>
>> I prefer first because it makes code more organized when there are lots
>> of lines. Besides, we're already doing it in most of our code.
>>
>> http://goo.gl/l7a88 I'm also working on this. I decided I would do this
>> because I'm a coding style freak. Code needs to be perfect and consistent
>> along all of our applications. In fact, I can volunteer to fix all the
>> dirty code we have (it's boring, but I don't care, I love doing it) in all
>> our apps, but only after we have a coding style defined.
>>
>> Which one do you prefer? Thanks, discuss, and don't forget to "Reply to
>> all".
>>
>>
>> --
>> David Gomes
>>
>> --
>> Mailing list: https://launchpad.net/~elementary-dev-community
>> Post to     : elementary-dev-community@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~elementary-dev-community
>> More help   : https://help.launchpad.net/ListHelp
>>
>>
>
>
> --
> Scott Ringwelski
> 231-492-5380
> sgringwe@xxxxxxx
>
>
> --
> Mailing list: https://launchpad.net/~elementary-dev-community
> Post to     : elementary-dev-community@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~elementary-dev-community
> More help   : https://help.launchpad.net/ListHelp
>
>