ROS JavaScript Style Guide

This page defines a style guide to be followed in writing JavaScript code for ROS. This guide applies to all ROS code, both core and non-core.

For Python, see the Python Style Guide and for C++, see the C++ Style Guide

Coding Style

A quick summary is:

• 2 space indention

• camelCase variables and function names, CapitalCamelCase for classes, CAPS for namespaces, CAPS for constants

• Semicolons are good

• JSDoc for documentation

• Triple equals (===) for comparisons

An example can be worth a thousand words:

/**
 * Performs an example task.
 *
 * @param foo - task selector
 */
function exampleTask(foo) {
  var myVar = 'My message';

  if (foo === 'Do this') {
    anotherExampleTask(myVar);
  }
  else {
    someOtherTask(myVar);
  }
}