Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
11 days ago
—
11 days old
Documentation comment not found for arrow function
mergeVulnerability253 }
254};
255
256export const mergeVulnerability = async (257 mergeObject: MergeVulnerability,
258): Promise<{ status: string; datas: string }> => {
259 try {Documentation comment not found for arrow function
updateVulnerability201 }
202};
203
204export const updateVulnerability = async (205 vulnerability: UpdateVulnerabilityData,
206): Promise<{ status: string; datas: string }> => {
207 try {Documentation comment not found for arrow function
deleteVulnerability182 }
183};
184
185export const deleteVulnerability = async (186 id: string,
187): Promise<{ status: string; datas: string }> => {
188 try {Documentation comment not found for arrow function
postVulnerability155 }
156};
157
158export const postVulnerability = async (159 vulnerability: NewVulnerability[],
160): Promise<{ status: string; datas: CreatedData }> => {
161 try {Documentation comment not found for arrow function
getVulnerabilities136 }
137};
138
139export const getVulnerabilities = async (): Promise<{140 status: string;
141 datas: UpdateVulnerabilityData[];
142}> => {
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;
}