Force esdoc to process non ES6 code

I understand that esdoc is designed for ES6. And I code in ES6 as much as I can, but Node does not implement import.

I’ve read #168 but still don’t know how to force esdoc to document something like this:

module.exports =
{
  /**
   * Main function of the module blablabla
   */
  doStuff: function()
  {
    // do stuff
  }
};

I don’t think a plugin-feature may help here. Isn’t there a “tag” or something that tells esdoc “please process this”?

[h13i32maru]

Sorry for late reply.

I don’t have plan to support require/module.exports. However you can use esdoc-node that is third party plugin for it. And you may solves your problems.

[adamjmurray]

I’m having difficulty with this too.

I’m working on modern Node modules that use native ES6 support in Node 6+ (which is now the long-term-support version of Node encouraged for all Node developers to use: https://nodejs.org).

I don’t want the added overhead and complexity of Babel just for documentation. I would like to use ESDoc, but for now it doesn’t seem to be an option for me because it doesn’t understand require() and module.exports.

I’d be happy to write more annotations in my ESDoc comments to give it the hints it needs to document my code, but this doesn’t seem to be possible right now. For comparison, JSDoc has tags like @class and @function. JSDoc doesn’t actually support most ES6 syntax yet, but I am able to make it work well enough by using these tags to explicitly document syntax structures it does not understand.

TL;DR - JSDoc currently works better for my native Node 6 / ES6 code, so I’ll keep using that for now. However, I am interested in ESDoc and I’ll reevaluate it periodically.