JSDoc support for Prisma schema files — both /** */ block comments and /// triple-slash doc comments.
Features
Syntax Highlighting
JSDoc tags, types, and parameter names are highlighted inside both comment styles:
/**
* @deprecated Use NewUser instead.
* @since 2.0.0
* @model
*/
model OldUser {
/// @param {string} name - The user's display name
/// @unique
name String @unique
}
Highlighted elements:
- Tags — all standard TSDoc tags plus Prisma-specific ones (
@model,@field,@relation, etc.) - Type expressions —
{string},{User | null},{Record<string, unknown>} - Parameter names — the identifier after
@param {type} - Inline links —
{@link SomeModel} - Leading asterisks — the
*on continuation lines inside/** */blocks
Comment Continuation
Pressing Enter at the end of a comment line continues the comment:
- After
/**→ next line starts with* - On a
* textline inside a block → next line starts with* - After
///→ next line starts with///
IntelliSense Completions
Type @ inside any doc comment to get completions for all supported tags with snippets and descriptions.
Works in both /** */ blocks and /// lines.
Prisma-specific tags
| Tag | Mirrors |
|---|---|
@model |
Prisma model declaration |
@field |
Model field |
@relation |
Relation to another model |
@unique |
@@unique constraint |
@id |
@id field attribute |
@updatedAt |
@updatedAt attribute |
@map |
@map / @@map attribute |
@db |
@db.* native type |
@index |
@@index attribute |
Requirements
- Prisma extension — for full Prisma language support (formatting, validation, go-to-definition)
5m1ly.gpec-javascript— auto-installed as a dependency; provides the TSDoc-backed tag registry
Release Notes
See CHANGELOG.md.