Style Guide

Style Guide

General

• Indentation - 2 spaces
• Line Length - 80 characters
• Required License in File Header

Naming

• variables and functions - lowerCamelCase
• constructor like functions - UpperCamelCase
• constants - ALL_UPPER_CASE_WITH_UNDERSCORES

Braces

• Always use braces and put them on same line even for single line control statements

if (someVar) {
  return true;
} else {
  return null;
}

Note: This wasn't always followed, but any new code should do this.

White Space

• Space after control statements (if, else, while, for, ...)

if (someVar) {

Classes

The standard way of creating classes in pdf.js is the following. Please note that by class we mean an object that is class-like. Also, note the naming of all anonymous functions.

var ClassName = (function ClassNameClosure() {
  function ClassName(...) {
    ...
  }

  ClassName.prototype = {
    functionName: function ClassName_functionName(...) {
      ...
    }
  };

  return ClassName;
})();