Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
a year ago
—
a year old
Documentation comment not found for method definition eventHandler
116 }, 2000);
117 }
118
119 async eventHandler() {120 ValorantClient.on('gameReady', () => {
121 this.clientLogin();
122 });Documentation comment not found for method definition clientLogin
19 this.eventHandler();
20 }
21
22 async clientLogin() { 23 this.client.login({ clientId: this.clientId }).then(this.isReady = true).catch((error) => {
24 this.isReady = false;
25 new Notification({Documentation comment not found for class Presence
5const Valorant = require('./client/valorant');
6const ValorantClient = new Valorant();
7
8class Presence { 9 constructor() {
10 this.clientId = '1025869206253748295';
11 RPC.register(this.clientId);Documentation comment not found for method definition clientDestroy
29 });
30 }
31
32 async clientDestroy() { 33 this.client.destroy().then(this.isReady = false).catch(console.log);
34 }
35Documentation comment not found for method definition _init
33 this.client.destroy().then(this.isReady = false).catch(console.log);
34 }
35
36 async _init() { 37 this.maps = await axios.get('https://valorant-api.com/v1/maps').then(res => res.data.data);
38
39 let interval = setInterval(async () => {
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;
}