Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
8 months ago
—
a year old
Documentation comment not found for function expression
multiClose3741 })();
3742 };
3743
3744 var multiClose = function(thisRef, options) {3745
3746 var self = thisRef;
3747 var html = '<a href="javascript:void(0)" class="' + options.className + '" tabindex="-1" title="' + escape_html(options.title) + '">' + options.label + '</a>';Documentation comment not found for function expression
singleClose3695 append : true
3696 }, options);
3697
3698 var singleClose = function(thisRef, options) {3699
3700 options.className = 'remove-single';
3701 Documentation comment not found for function expression
equalizeSizes3653 return width;
3654 };
3655
3656 var equalizeSizes = function() {3657 var i, n, height_max, width, width_last, width_parent, $optgroups;
3658
3659 $optgroups = $('[data-group]', self.$dropdown_content);Documentation comment not found for function expression
getScrollbarWidth3637 };
3638 })();
3639
3640 var getScrollbarWidth = function() {3641 var div;
3642 var width = getScrollbarWidth.width;
3643 var doc = document;Documentation comment not found for function expression
addGroup3443 }
3444 };
3445
3446 var addGroup = function($optgroup) {3447 var i, n, id, optgroup, $options;
3448
3449 $optgroup = $($optgroup);
Description
It is recommended to have documentation comments above, or right inside a function/class declaration. This helps developers, users and even the author understand the purpose of a code snippet or API function in the future.
NOTE: If you want to stop this issue from getting raised on certain constructs (arrow functions, class expressions, methods etc.), consider using the skipdoccoverage option under the analyzers.meta property in your .deepsource.toml file.
For example, the following configuration will silence this issue for class expressions and method definitions:
[analyzers.meta]
skip_doc_coverage = ["class-expression", "method-definition"]
Bad Practice
function sum(a, b) {
return a + b;
}
Recommended
/**
* Function to add two numbers
* @param a The first number to add
* @param b The second number to add
* @returns The sum of two numbers
*/
function sum(a, b) {
return a + b;
}