Skip to content

Latest commit

 

History

History
87 lines (74 loc) · 3.54 KB

StyleGuide.md

File metadata and controls

87 lines (74 loc) · 3.54 KB
Raw

FOAM2 Coding Style Guidelines

Except where noted below, FOAM conforms to the Google Javascript Style Guide.

Exceptions

  • One space is required inside the parentheses of if, for, while, and switch headers:
if ( a < b ) ...
for ( var i = 0 ; i < words.length ; i++ ) ...
for ( var key in obj ) ...
while ( true ) ...
switch ( argCount ) ...
  • The ! operator must be followed by a space.
if ( ! found ) ...
  • One-statement if, while, and for statements that can fit on a single line (less than 80 characters) do not need braces:
if ( ! found ) return false;

for ( var i = 0 ; i < a.length ; i++ ) a[i] = '';
  • The rules about using Closure's goog.provide, goog.require and similar are omitted; use FOAM's requires: [] support instead.
  • The rules about using JSDoc comments to inform the Closure compiler's type-checking are omitted; use FOAM's type-checking instead.
  • Encourage the use of vertical alignment where it makes sense, since it makes code easier to read. Ex.:
  var firstName = 'John';
  var lastName  = 'Smith';
  var age       = 42;
  • The Google standard uses two space for indentation but four spaces for line continuation. This is conflicting for FOAM since the U2 library is an internal DSL for creating virtual DOM and it relies on long heirarchical continued statements. While this is technically a continued statement, and should therefore use four spaces, the indent is clearly one of structural indentation, which would require two. To avoid the conflict FOAM uses two spaces of indentation in both case. Ex.:
      this
        .addClass(this.myClass())
        .start()
          .start('p')
            .addClass('label')
            .add(this.data)
            .startContext({ data: this })
              .add(this.REMOVE_SELF)
            .endContext()
          .end()
        .end();

Naming

  • Model names should be capitalized CamelCase. Ex. Model, Photo, EMail.
  • Acronyms should have all letters capitalized: Ex. DAO
  • Properties should start with a lower-case character and be camelCase. Ex. parent, firstName
  • Non-public properties and methods can end with an underscore (_). Ex. listeners_
  • Use NAMES_LIKE_THIS for constant and message names.

Modelling

Code should be modeled rather than created as conventional JS prototypes.

Provide property labels when the default labelization of the property name will not be helpful or attractive to users.

Line Length

Line lengths should be 80 characters or less, except for embedded data, like templates or sprites, or when modifying the code to make it fit in less than 80 characters would actually makes it less readable.

Calling DAO's From Java

When implementing DAO strategies in Java, implement the Context-Oriented (CO) methods, ie. those ending with _ and explicitly taking Contexts as the first paramter, like:

   find_(X x, Object query).

When implementing DAO decoratores in Java, implement the CO methods and also delegate to the CO method of your delegate. ie.

   getDelegate().find_(x, id).

When using a DAO as a regular client from outside of a decorator for that DAO, use the non-CO methods and use inX() to specify the context. ie.

   DAO userDAO = ((DAO) x.get("userDAO")).inX(x);
   userDAO.find(id);

Other

  • Do not quote map keys unless necessary.
  • Do not leave trailing unnecessary commas (this is implicit in the Google style guide).

Comments