Documenting "interfaces" in JavaScript

console

> npm install -g yuidocjs
> yuidoc -o doc src

Foo.js

/**
 * Foo
 * 
 * @class Foo
 * @constructor
 */
function Foo() {}

Foo.prototype = {
  /**
   * foo
   * 
   * @method foo
   * @param {Object} bah
   * @param {String} bah.name
   * @param {Function} bah.getName
   * @return {Boolean}
   */
   foo: function(bah) {
   	return false;
   }
};

JavaScript documentation syntaxes like JSDoc and YUIDoc let you specify nested properties, so you could describe the members your object is expected to have. Which is sort of like describing an interface.

This example assumes that Foo.js is in the directory src.