Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
a year ago
—
a year old
Documentation comment not found for function declaration
main16}
17
18
19function main() {20 let p = [];
21 generatePrimes(p, 1e6);
22 return p[10000];Documentation comment not found for function declaration
generatePrimes 1function generatePrimes(primes, MAX_SIZE){ 2 let IsPrime = Array(MAX_SIZE).fill(true);
3
4 let p,i;Documentation comment not found for function declaration
main 1function main() { 2 let total = 0;
3 let total2 = 0;
4 for (let i = 1; i <= 100; i++) {Documentation comment not found for function declaration
gcd 1function gcd(a, b) { 2 while (b != 0) {
3 c = a % b;
4 a = b;Documentation comment not found for function declaration
main 7 return a;
8}
9
10function main() {11 let count = 1;
12 for (let j = 1; j <= 20; j++) {
13 count *= Math.floor(i / gcd(i, count));
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;
}