Script documentation format for Javascript

I am writing my script files in Javascript as opposed to Coffeescript and I keep getting an error with my documentation:

[Fri Nov 13 2015 15:15:54 GMT-0800 (PST)] INFO /home/sankethkatta/hubot/scripts/example.js is using deprecated documentation syntax

I am trying to follow the convention explained in the docs: https://github.com/github/hubot/blob/master/docs/scripting.md#documenting-scripts

I’ve tried replacing the # with // as well as a block style:

/**
 * <all the docs here>
 */

I still get the same error, no matter how I format it. Is there a preferred way of documenting for Javascript?

[sankethkatta]

Looking at the parseHelp method in robot.coffee#L505. I found that the // comment format works:

// Description:
//   <description of the scripts functionality>
// ...

However, it must be the first line of the file or parseHelp stops parsing the file. It is important to note that the doc must come before any other code. My issue was that I was using a 'use strict'; declaration at the top of the file.

So your file should really look like this with any other require statements also written after the doc:

// Description:
//   <description of the scripts functionality>
// ...

'use strict';

var util = require('util');

module.exports = function(robot) { ... }

[Romanski1]

https://github.com/Romanski1