Documentation comments not found for functions and classes JS-D1001
Documentation
Minor
2 years ago
—
2 years old
Documentation comment not found for method definition
saveAsImage30 this.qrCodeDownloadLink = url;
31 }
32
33 saveAsImage(parent: any): void {34 let parentElement = null;
35
36 if (this.elementType === 'canvas') {Documentation comment not found for method definition
cancel18
19 constructor(protected projectService: ProjectService, protected activeModal: NgbActiveModal, private location: Location) {}
20
21 cancel(): void {22 this.activeModal.dismiss();
23 }
24Documentation comment not found for method definition
getURLForProject22 this.activeModal.dismiss();
23 }
24
25 getURLForProject(project: IProject): string {26 return `${location.origin}/project/${project.id!}/view`;
27 }
28Documentation comment not found for class declaration
ProjectQrDialogComponent11 templateUrl: './project-qr-dialog.component.html',
12 styleUrls: ['./project-qr-dialog.component.scss'],
13})
14export class ProjectQrDialogComponent {15 project?: IProject;
16 public qrCodeDownloadLink: SafeUrl = '';
17 elementType: QRCodeElementType = 'canvas' as QRCodeElementType;Documentation comment not found for method definition
onChangeURL26 return `${location.origin}/project/${project.id!}/view`;
27 }
28
29 onChangeURL(url: SafeUrl): void {30 this.qrCodeDownloadLink = url;
31 }
32
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;
}