Prismaのschema.prismaファイルでJsDocって使えたんだの気づき

ちょっとした学び

恥ずかしながら知らなかったのですが、prismaでたまにコメントを書くことがあったのですが、こんな感じでjsdocもかけることを知りました。

/// @deprecated 今後はFugaを使うので使わないでください。
model Hoge {
  id String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
}

下記は実際に自動生成をされたものになります。

/**
 * Model Hoge
 * @deprecated 今後はFugaを使うので使わないでください。
 */
export type Hoge = $Result.DefaultSelection<Prisma.$HogePayload>

データベース内のデータ移行の時などに直ぐにテーブルを消せないけど、使って欲しくないときに@deprecatedでちゃんと斜線が出て非推奨であることも明示できるので、今後使っていきたいと思います。