Enforce JSDoc

[samjohnb]

Static analysis tools such as Java's CheckStyle and C#'s StyleCop can enforce code documentation for classes, methods and fields. I would like our client-side code documentation to be as comprehensive as our server-side. Would it be possible for JSCS to have a rule that says "you must document [method|class|field] x"?

[qfox]

I suppose you should take a look at https://github.com/zxqfox/jscs-jsdoc/
Agreed with your mention, it will be useful option

[samjohnb]

Thanks for your help. This certainly looks useful, but I don't think jscs-jsdoc enforces the use of JSDoc. My use case would be that, this would pass

/**
* This function returns something
*
* @param {string} b An argument
* @returns {string} Something to return
*/
function a(b) {
   return "something";
}

but, this would fail (because there's no documentation):

function a(b) {
   return "something";
}

[qfox]

@samjohnb Yeah. I understand and can implement this check.

[samjohnb]

Wow, fantastic, thanks! It would be great if this could work for all function declarations, i.e.

function a(b) {}
thing = function() {}
anotherthing(function() {})

The last one is particularly important as we are developing in AngularJS, so we have a lot of code that looks like this:

app.controller('mainController', [ '$scope', 'dataFactory', '$filter',
    function($scope, dataFactory, $filter) {
...

and it's important that we document what the controller is for, so this would be fine:

app.controller('mainController', [ '$scope', 'dataFactory', '$filter',

    /**
    * Controller for foo
    * @param {scope} scope The scope
    * @param {dataFactory} datafactory The data factory
    * @param {filter} filter The filter
    /*
    function($scope, dataFactory, $filter) {
...

[mikesherov]

@samjohnb please continue this discussion on jscs-dev/jscs-jsdoc#4 . Thanks again for contributing!