Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
6 months ago
—
10 months old
Documentation comment not found for arrow function
onRenderBody 5
6import type { RenderBodyArgs } from "gatsby";
7
8export const onRenderBody = ( 9 { setHeadComponents, setBodyAttributes }: RenderBodyArgs,
10 pluginOptions: GatsbyPluginFixFoucOptions,
11): void => {Documentation comment not found for arrow function
onInitialClientRender 3
4import type { BrowserPluginArgs } from "gatsby";
5
6export const onInitialClientRender = ( 7 _: BrowserPluginArgs,
8 pluginOptions: GatsbyPluginFixFoucOptions,
9): void => {Documentation comment not found for arrow function
pluginOptionsSchema 1import type { GatsbyNode } from "gatsby";
2import type { GatsbyPluginFixFoucOptions } from "./";
3
4export const pluginOptionsSchema: Required<GatsbyNode>["pluginOptionsSchema"] = 5 ({ Joi }) => {
6 const schema: Record<keyof GatsbyPluginFixFoucOptions, any> = {
7 attributeName: Joi.string(),
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;
}