TSDocメモ
CDKでtypescriptを使い始めて、コメントはTSDocがいいらしいと聞いて軽く調査したメモ
TSDocとは
- Microsoftとかが仕様を作っている規約とパーサ
- TypeScriptで使われる
- JSDocにゆるく基づいてるためJSDocと基本的なフォーマットが一緒
All these tools recognize a syntax that is loosely based on JSDoc
試すには
- リファレンス: TSDoc: @alpha
- TSDoc Playground: TSDoc Playground
メモ
- VSCodeはsyntax highlightingに対応している
- プロジェクト全体にtsdoc付ける、みたいなのはまだなさげ?
- eslintのプラグインはあるのでチェックできる: eslint-plugin-tsdoc - npm