TSDocの検索結果1 - 2 件 / 2件

• あとで読む

  ESLint を使って JSDoc / TSDoc の記述を必須化する

  • 21 users
  • zenn.dev/wakamsha
  • テクノロジー
  • 2023/07/27

  これはなに コードベースに対し JSDoc の記述を必須化するための ESLint 設定手順をまとめたものです。 JSDoc を始めとする Doc コメントはコードに最も近いドキュメントであり、これがあるのと無いのとではコードベースの保守性に天と地ほどの差が生まれます。そんな JSDoc ですが、OSS ならともかく（内製・受託を問わず）商業ソフトウェア開発の現場では軽視されがちです。後からコーディング規約を定めたところで開発メンバーにドキュメントを書く習慣が備わっていなければ書き漏れが頻発するのが関の山です。 コードレビューで都度指摘するにはあまりにコストがかかるため、ESLint に委ねるのが望ましいです。 前提 フレームワークは React（or Next.js）を使っている。 TypeScript を主体としている。 ビルドスクリプトや設定ファイルは JavaScript も併用し

  • eslint
  • TypeScript
  • jsdoc
  • javascript
  • js
  • あとで読む
  • article
  • *あとで読む

  
• あとで読む

  GitHub - sasaplus1/textlint-plugin-tsdoc: textlint plugin for tsdoc

  • 14 users
  • github.com/sasaplus1
  • テクノロジー
  • 2023/01/01

  You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert

  • TypeScript
  • あとで読む
  • plugin
  • github