タグ

AtomとActionScriptに関するthree_beeのブックマーク (1)

  • JavaScriptでJSDocコメントを書くメリットとは – ICS MEDIA

    筆者が試したところ、開発環境としてWebStormやVS Codeがとくに優れており、ツールチップにJSDocコメントの情報がすべて表示されました。 ちなみにReactAngularなどのメジャーなJSライブラリにおいても、そのソースコードではJSDocコメントが使われています (例 : AngularReact)。APIが多岐に渡るJSライブラリを利用するとき、わざわざリファレンスをブラウザで開いたり解説書で調べることなく、コード上で関数の仕様を確認できます。 ▲描画ライブラリCreateJSのAPIを表示したもの JSDocコメントのメリット② APIリファレンスの生成 TypeDoc等のツールを使うことでコードのリファレンスドキュメントを作成できます。こういったJSライブラリのリファレンスはみなさんも一度は見たことがあるのではないでしょうか。 ウェブサイト案件のソースコードでAP

    JavaScriptでJSDocコメントを書くメリットとは – ICS MEDIA
  • 1