Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
5 months ago
—
5 months old
Documentation comment not found for arrow function
updateData 1import isArray from '../validation/isArray.js'
2
3const updateData = (fields, data, alreadyData) => { 4 const updateStructure = {}
5 fields.forEach((field, index) => {
6 console.log(updateStructure)Documentation comment not found for method definition
decline71 return orgID
72 }
73
74 decline () {75 this.fs.delete()
76 return true
77 }Documentation comment not found for method definition
approve55 this.requestID = requestID
56 }
57
58 approve () {59 const record = this.fs.read()
60 this.fs.delete()
61 this.fs = new Firestore('organizations', this.requestID)Documentation comment not found for class
MembershipRequestModel 3import FirestoreAbstract from '../../utils/firestore/FirestoreAbstract.js'
4import updateData from '../../utils/firestore/updateData.js'
5
6export default class MembershipRequestModel extends FirestoreAbstract { 7 constructor (
8 registrationCertificateUrl,
9 annualReportUrl,Documentation comment not found for arrow function
declineMembershipRequest15 const response = req.membershipInstance.approve();
16 res.sendStatus(200).json({ response });
17};
18const declineMembershipRequest = (req, res) => {19 const response = req.membershipInstance.decline();
20 res.sendStatus(200).json({ response });
21};
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;
}