Documentation comment not found for method definition
findById
23
24 }
25
26 static async findById({id}){27 const sellerFound = await prisma.seller.findFirst({
28 where:{
29 id
Documentation comment not found for method definition
findMany
11 })
12 }
13
14 static async findMany(){15
16 return await prisma.seller.findMany({
17
Documentation comment not found for method definition
create
2
3class SellerModel{
4
5 static async create({username, password}) { 6 return await prisma.seller.create({
7 data:{
8 username,
Documentation comment not found for class
SellerModel
1import prisma from "prisma"
2
3class SellerModel{ 4
5 static async create({username, password}) {
6 return await prisma.seller.create({
Documentation comment not found for method definition
findById
23
24 }
25
26 static async findById({id}){27 const salesManagerFound = await prisma.salesManager.findFirst({
28 where:{
29 id
Documentation comment not found for method definition
findMany
11 })
12 }
13
14 static async findMany(){15
16 return prisma.salesManager.findMany({
17
Documentation comment not found for method definition
create
2
3class SalesManagerModel{
4
5 static async create({username, password}) { 6 return prisma.salesManager.create({
7 data:{
8 username,
Documentation comment not found for class
SalesManagerModel
1import prisma from "prisma"
2
3class SalesManagerModel{ 4
5 static async create({username, password}) {
6 return prisma.salesManager.create({
Documentation comment not found for method definition
findById
16
17 }
18
19 static async findById({id}){20 const profileFound = await prisma.profile.findFirst({
21 where:{
22 id
Documentation comment not found for method definition
findMany
10 })
11 }
12
13 static async findMany(){14
15 return await prisma.profile.findMany()
16
Documentation comment not found for method definition
create
2
3class ProfileModel{
4
5 static async create({name}) { 6 return prisma.profile.create({
7 data:{
8 name
Documentation comment not found for class
ProfileModel
1import prisma from "prisma"
2
3class ProfileModel{ 4
5 static async create({name}) {
6 return prisma.profile.create({
Documentation comment not found for method definition
findById
20
21 }
22
23 static async findById({id}){24 const productFound = await prisma.product.findFirst({
25 where:{
26 id
Documentation comment not found for method definition
findMany
14 })
15 }
16
17 static async findMany(){18
19 return prisma.product.findMany()
20
Documentation comment not found for method definition
create
2
3class ProductModel{
4
5 static async create({username, category, stock, price, description}) { 6 return prisma.product.create({
7 data:{
8 username,
Documentation comment not found for class
ProductModel
1import prisma from "prisma"
2
3class ProductModel{ 4
5 static async create({username, category, stock, price, description}) {
6 return prisma.product.create({
Documentation comment not found for method definition
findById
28
29 }
30
31 static async findById({id}){32 const orderFound = await prisma.order.findFirst({
33 where:{
34 id
Documentation comment not found for method definition
findMany
14 })
15 }
16
17 static async findMany(){18
19 return prisma.order.findMany({
20
Documentation comment not found for method definition
create
2
3class OrderModel{
4
5 static async create({date, state, totalPrice, check, paymentMethod}) { 6 return prisma.order.create({
7 data:{
8 date,
Documentation comment not found for class
OrderModel
1import prisma from "prisma"
2
3class OrderModel{ 4
5 static async create({date, state, totalPrice, check, paymentMethod}) {
6 return prisma.order.create({
Documentation comment not found for method definition
findById
42
43 }
44
45 static async findById({id}){46 const clientFound = await prisma.client.findFirst({
47 where:{
48 id
Documentation comment not found for method definition
findMany
36 })
37 }
38
39 static async findMany(){40
41 return prisma.client.findMany({clientInclude})
42
Documentation comment not found for method definition
create
16
17class ClientModel {
18
19 static async create({username, email, password, address}) {20 return prisma.client.create({
21 data:{
22 username,
Documentation comment not found for class
ClientModel
14 }
15}
16
17class ClientModel {18
19 static async create({username, email, password, address}) {
20 return prisma.client.create({
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;
}