483739 - Establish style guidelines for storage

Status: RESOLVED FIXED

(Toolkit :: Storage, defect)

Description

[Shawn Wilsher :sdwilsh]

Attachment: v1.0

I want to get style guidelines established for the storage module so new contributors know exactly what to expect.

asuth - this review request is supposed to be more of a dialog since you are a peer.

Once we work these out, I'll start modifying our existing code to follow this style.

Comment 1

[Shawn Wilsher :sdwilsh]

Patch is missing one rule so far that I've noticed:
* All functions that are not XPCOM should start with a lowercase letter

Comment 2

[Andrew Sutherland [:asuth] (he/him)]

* Should local variables also be camelCased or is that left to the author's discretion?

* Should the license blocks have emacs and vim hints at the top?  A bunch (all?) of the files currently do, sometimes with the 'wrong' counts.  If so, the things to paste in should probably be in the style guide.

I always thought the 'a' was for argument?

Comment 3

[Shawn Wilsher :sdwilsh]

(In reply to comment #2)
> * Should local variables also be camelCased or is that left to the author's
> discretion?
I think camelCase is our convention.  I'll add that.

> * Should the license blocks have emacs and vim hints at the top?  A bunch
> (all?) of the files currently do, sometimes with the 'wrong' counts.  If so,
> the things to paste in should probably be in the style guide.
Yup, need to add that too.

> I always thought the 'a' was for argument?
Well, it's an argument for the caller, but it's a parameter for the function.  You don't want to prefix it with p though, since that prefix is used for pointer.  It's a minor technicality.

Comment 4

[Andrew Sutherland [:asuth] (he/him)]

Comment on attachment 367723 [details] [diff] [review]
v1.0

fine with me with the promised additions

Comment 5

[Shawn Wilsher :sdwilsh]

Attachment: v1.1

Per comments.  We'll probably find more things to add here over time.

Comment 6

[Shawn Wilsher :sdwilsh]

http://hg.mozilla.org/mozilla-central/rev/3407ca1084a6