Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
4 months ago
—
4 months old
Documentation comment not found for function declaration
train 1const tf = require('@tensorflow/tfjs');
2const model = require('./galactic_chain_model');
3
4async function train() { 5 const xs = tf.tensor2d([-1, 0, 1, 2, 3, 4], [6, 1]);
6 const ys = tf.tensor2d([-3, -1, 1, 3, 5, 7], [6, 1]);
7Documentation comment not found for function declaration
test 1const tf = require('@tensorflow/tfjs');
2const model = require('./galactic_chain_model');
3
4async function test() { 5 const inputData = tf.tensor2d([5], [1, 1]);
6 const output = model.predict(inputData);
7
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;
}