Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
5 months ago
—
2 years old
Documentation comment not found for arrow function
load1export const load = ({ params }: any) => {2 return params;
3};
Documentation comment not found for arrow function
load1export const load = ({ params }: any) => {2 return params;
3};
Documentation comment not found for arrow function
load1export const load = ({ params }: any) => {2 return params;
3};
Documentation comment not found for function declaration
getPublicIP 5export let ip;
6getPublicIP((ipAddress) => (ip = ipAddress));
7
8function getPublicIP(callback) { 9 fetch("https://api.ipify.org?format=json")
10 .then((response) => response.json())
11 .then((data) => callback(data.ip))
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;
}