Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
a month ago
—
a month old
Documentation comment not found for function declaration
sendMessage10 messages.appendChild(message);
11});
12
13function sendMessage() {14 const messageInput = document.getElementById('message');
15 const message = messageInput.value;
16 socket.emit('message', message);Documentation comment not found for arrow function
sendPushNotification31 });
32});
33
34const sendPushNotification = (message) => {35 const payload = {
36 notification: {
37 title: 'New Message',Documentation comment not found for arrow function
askQuestion19 'I have selected a random number between 1 and 100. Can you guess it?'
20)
21
22const askQuestion = () => {23 rl.question('Enter your guess: ', (answer) => {
24 const guess = parseInt(answer, 10)
25 attempts += 1
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;
}