JS-D1001 @ 8d2fcac • Olimpiadas-INET-2024-Escuela-Tecnica-21 / fase1

Run summary

25 days ago

89998fd..8d2fcac

14 s

Documentation comments not found for functions and classes JS-D1001

Documentation

Minor

24 occurrences in this check

Documentation comment not found for class Seller

src/entities/seller.js

1import { Entity } from './entity.js';
2
3class Seller extends Entity {4}
5
6export default Seller

Documentation comment not found for class SalesManager

src/entities/salesManager.js

1import { Entity } from './entity.js';
2
3class SalesManager extends Entity {4}
5
6export default SalesManager

Documentation comment not found for class SellerRepository

src/entities/repository.js

124    }
125}
126
127class SellerRepository extends Repository {128    static #instance = undefined
129
130    constructor() {

Documentation comment not found for class SalesManagerRepository

src/entities/repository.js

105    }
106}
107
108class SalesManagerRepository extends Repository {109    static #instance = undefined
110
111    constructor() {

Documentation comment not found for class ProfileRepository

src/entities/repository.js

 86    }
 87}
 88
 89class ProfileRepository extends Repository { 90    static #instance = undefined
 91
 92    constructor() {

Documentation comment not found for class ProductRepository

src/entities/repository.js

 67    }
 68}
 69
 70class ProductRepository extends Repository { 71    static #instance = undefined
 72
 73    constructor() {

Documentation comment not found for class OrderRepository

src/entities/repository.js

 48    }
 49}
 50
 51class OrderRepository extends Repository { 52    static #instance = undefined
 53
 54    constructor() {

Documentation comment not found for class ClientRepository

src/entities/repository.js

 29    async delete(){}
 30}
 31
 32class ClientRepository extends Repository { 33    static #instance = undefined
 34
 35    constructor() {

Documentation comment not found for method definition delete

src/entities/repository.js

 26
 27    async update(){}
 28
 29    async delete(){} 30}
 31
 32class ClientRepository extends Repository {

Documentation comment not found for method definition update

src/entities/repository.js

 24
 25    async findOne(){}
 26
 27    async update(){} 28
 29    async delete(){}
 30}

Documentation comment not found for method definition findOne

src/entities/repository.js

 22
 23    async findMany(){}
 24
 25    async findOne(){} 26
 27    async update(){}
 28

Documentation comment not found for method definition findMany

src/entities/repository.js

 20
 21    async create(data){}
 22
 23    async findMany(){} 24
 25    async findOne(){}
 26

Documentation comment not found for method definition create

src/entities/repository.js

 18        console.log(`hello from ${Object.getPrototypeOf(this).constructor.name}`);
 19    }
 20
 21    async create(data){} 22
 23    async findMany(){}
 24

Documentation comment not found for method definition sayHello

src/entities/repository.js

 14
 15    }
 16
 17    sayHello() { 18        console.log(`hello from ${Object.getPrototypeOf(this).constructor.name}`);
 19    }
 20

Documentation comment not found for class Profile

src/entities/profile.js

1import { Entity } from './entity.js';
2
3class Profile extends Entity {4}
5
6export default Profile

Documentation comment not found for class Product

src/entities/product.js

1import { Entity } from './entity.js';
2
3class Product extends Entity {4}
5
6export default Product

Documentation comment not found for class Order

src/entities/order.js

1import { Entity } from './entity.js';
2
3class Order extends Entity {4}
5
6export default Order

Documentation comment not found for method definition delete

src/entities/entity.js

13
14    async update() {}
15
16    async delete() {}17}

Documentation comment not found for method definition update

src/entities/entity.js

11
12    async findByID() {}
13
14    async update() {}15
16    async delete() {}
17}

Documentation comment not found for method definition findByID

src/entities/entity.js

 9
10    async findMany() {}
11
12    async findByID() {}13
14    async update() {}
15

Documentation comment not found for method definition findMany

src/entities/entity.js

 7
 8    async create() {}
 9
10    async findMany() {}11
12    async findByID() {}
13

Documentation comment not found for method definition create

src/entities/entity.js

 5        }
 6    }
 7
 8    async create() {} 9
10    async findMany() {}
11

Documentation comment not found for class Entity

src/entities/entity.js

 1export default class Entity { 2    constructor() {
 3        if (new.target === Entity) {
 4            throw new Error('Cannot create an instance of Entity because it is an abstract class');

Documentation comment not found for class ClientModel

src/entities/client.js

1import Entity from "./entity.js"
2
3class ClientModel extends Entity {4}
5
6export default ClientModel

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;
}

Olimpiadas-INET-2024-Escuela-Tecnica-21 / fase1_backend

Bad Practice

Recommended