Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
a year ago
—
a year old
Documentation comment not found for function declaration refreshData
53 }
54 }, [apiReady]);
55
56 function refreshData() { 57 if (refreshDisabled) return;
58 if (user.mzn_instances.length > 0) {
59 setRefreshDisabled(true);Documentation comment not found for function declaration deleteRun
114 });
115 }
116
117 function deleteRun(run: Run, solver_ids: number[] | null = null) {118 setDeletingRun(true);
119 post(`/runs/delete/${run.id}`, "", (r) => {
120 if (r.success) {Documentation comment not found for function declaration terminateSolvers
75 }
76 }
77
78 function terminateSolvers(run: Run, solver_ids: number[] | null = null) { 79 setDeletingRun(true);
80 post(`/runs/terminate`, { solver_ids, run_id: run.id }, (r) => {
81 if (r.success) {Documentation comment not found for function declaration handleStopRun
66 }
67 }
68
69 function handleStopRun(run: Run) { 70 if (run.solvers.length < 2) {
71 terminateSolvers(run);
72 } else {Documentation comment not found for function declaration Runs
27 7: "info", // Proving Optimality
28};
29
30export default function Runs({ 31 user,
32 setNotification,
33}: HomeSubpageBasePropT & {
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;
}