Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
15 days ago
—
2 years old
Documentation comment not found for arrow function
getDefaults58 res.send(ret);
59};
60
61const getDefaults = async (req: Request, res: Response, next: NextFunction) => {62 console.log(req.query, req.query.mint, req.query["mint"]);
63 let primitive = req.query.mint;
64 let key = primitive as string;Documentation comment not found for arrow function
getTerminals27 return res.send({"x-span":ret.xspan, "y-span":ret.yspan});
28};
29
30const getTerminals = async (req: Request, res: Response, next: NextFunction) => {31 let primitive = req.query.mint;
32 let key = primitive as string;
33 let technology = ComponentAPI.getComponentWithMINT(key);Documentation comment not found for arrow function
getDimensions 5
6paper.setup(new paper.Size([64000, 48000]));
7
8const getDimensions = async (req: Request, res: Response, next: NextFunction) => { 9 let primitive = req.query.mint;
10 let key = primitive as string;
11 let technology = ComponentAPI.getComponentWithMINT(key);Documentation comment not found for method definition
get 3class EventBus extends EventEmitter {
4 private static instance: EventBus | null = null;
5
6 static get(): EventBus { 7 if (EventBus.instance === null) {
8 EventBus.instance = new EventBus();
9 }Documentation comment not found for class
EventBus 1import EventEmitter from "eventemitter3";
2
3class EventBus extends EventEmitter { 4 private static instance: EventBus | null = null;
5
6 static get(): EventBus {
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;
}