Schema comments not showing in generated client

Bug description

From the schema comments documentation I understand that triple-slash comments result in the comments existing in the final client types/objects, hence will show up in intellisense in VSCode. Somehow, for me, that does not work at all. Am I missing something that this might currently not be supported in my environment?

How to reproduce

Expected behavior

Comments show up in prop description in vscode.

Prisma information

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

/// This comment should show up as field description (intellisense)
model Image {
  id   String @id @default(cuid())
  /// This should show up as well
  name String
  path String
  hash String @unique
}

Environment & setup

• OS: Mac OS
• Database: PostgreSQL 9
• Node.js version: 12.16.2
• Prisma version: 2.5.1

Any ideas?

[pantharshit00]

Yes, those comments does show up in the internal AST but we don’t render a JSDoc comment for them. I think we can do that.

[millsp]

Today, we produce comments for the model types and its properties. However, even though we have commented types, intellisense won’t show up on top-level types unless referenced directly (ie. type-level only, import that type).

const prisma = new PrismaClient()

const comment = (await prisma.comment.findMany())[0]

comment.content // works with intellisense
comment // does not show intellisense hint

So I think, one solution to showing top-level model/type comments would be to do this on prisma.<model>.

const prisma = new PrismaClient()

prisma.comment // hovering here would show the intellisense comment

Right now, we have generated examples there, but I don’t see why we could not prepend user comments.