Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
5 months ago
—
2 years old
Documentation comment not found for function declaration
o11795 ? (e.addEventListener(n, o, !1), { element: e, handler: o, event: n })
11796 : (e.attachEvent("on" + n, a), { element: e, handler: a, event: n });
11797 }
11798 function o(e) {11799 e.element.removeEventListener
11800 ? e.element.removeEventListener(e.event, e.handler)
11801 : e.element.detachEvent("on" + e.event, e.handler);Documentation comment not found for function declaration
a11783 var n = t.apply(this, arguments);
11784 return !1 === n && (e.stopPropagation(), e.preventDefault()), n;
11785 }
11786 function a() {11787 var n = t.call(e, window.event);
11788 return (
11789 !1 === n &&Documentation comment not found for function declaration
o11779 })(e, l);
11780 }
11781 function t(e, n, t) {
11782 function o(e) {11783 var n = t.apply(this, arguments);
11784 return !1 === n && (e.stopPropagation(), e.preventDefault()), n;
11785 }Documentation comment not found for function declaration
t11778 : (e.className = e.className + " " + n);
11779 })(e, l);
11780 }
11781 function t(e, n, t) {11782 function o(e) {
11783 var n = t.apply(this, arguments);
11784 return !1 === n && (e.stopPropagation(), e.preventDefault()), n;Documentation comment not found for function declaration
n11757 eval("exports.default = AU"));
11758var AU = AU || {};
11759!(function (e) {
11760 function n(e, n, t, o) {11761 if ("opening" === n || "open" === n)
11762 var a = t || "au-main-nav__content--closed",
11763 l = o || "au-main-nav__content--open";
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;
}