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
i13 function o() {
14 return Boolean(window.wc.darkLightEnabled);
15 }
16 function i() {17 if (!o())
18 return (
19 console.debug("User theming disabled."),Documentation comment not found for function declaration
o10 function s() {
11 return parseInt(localStorage.getItem("wcTheme") || 2);
12 }
13 function o() {14 return Boolean(window.wc.darkLightEnabled);
15 }
16 function i() {Documentation comment not found for function declaration
s 7 var t,
8 n,
9 e = document.body;
10 function s() {11 return parseInt(localStorage.getItem("wcTheme") || 2);
12 }
13 function o() {Documentation comment not found for function expression
e4203 }),
4204 (e._close = function () {
4205 var t = this,
4206 e = function () {4207 t._element.classList.add("hide"),
4208 i.default(t._element).trigger("hidden.bs.toast");
4209 };Documentation comment not found for function expression
n4141 if ((i.default(this._element).trigger(e), !e.isDefaultPrevented())) {
4142 this._clearTimeout(),
4143 this._config.animation && this._element.classList.add("fade");
4144 var n = function () {4145 t._element.classList.remove("showing"),
4146 t._element.classList.add("show"),
4147 i.default(t._element).trigger("shown.bs.toast"),
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;
}