storage/style.txt
author Shawn Wilsher <me@shawnwilsher.com>
Tue, 31 Mar 2009 07:26:08 -0700
changeset 26765 d249eca423fd0e38c9f641c6f348d072a8aaab73
parent 26420 3407ca1084a6fd02419d28227eb6138ce935e2ce
child 27270 3fe0af99bdbe10c1593a0303eea92af28b2853ae
permissions -rw-r--r--
Bug 485626 - Update style guidelines to reflect namespace discussions r=asuth

Storage Module Style Guidelines

These guidelines should be followed for all new code in this module.  Reviewers
will be enforcing them, so please obey them!

* All code should be contained within the namespace mozilla::storage at a
  minimum.  The use of namespaces is strongly encouraged.

* All functions being called in the global namespace should be prefixed with
  "::" to indicate that they are in the global namespace.

* The indentation level to use in source code is two spaces.  No tabs, please!

* All files should have the following emacs and vim mode lines:
  -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  vim: sw=2 ts=2 sts=2 et :

* All functions that are not XPCOM should start with a lowercase letter.

* Function arguments that are not out parameters should be prefixed with a (for
  pArameter), and use CamelCase.

* Function arguments that are out parameters should be prefixed with an
  underscore and have a descriptive name.

* Function declarations should include javadoc style comments.

* For function implementations, each argument should be on its own line.

* All variables should use camelCase.

* The use of bool is encouraged whenever the variable does not have the
  potential to go through xpconnect.

* For pointer variable types, include a space after the type before the asterisk
  and no space between the asterisk and variable name.

* If any part of an if-else block requires braces, all blocks need braces.

* Every else should be on a newline after a brace.

* Bracing should start on the line after a function and class definition.

* If a return value is not going to be checked, the return value should be
  explicitly casted to void (C style cast).