タグ

jsdocに関するkitokitokiのブックマーク (3)

  • 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
  • JsDoc Toolkitを使う!

    JsDoc Toolkitを使う!」は、JavaScriptドキュメンテーションツールであるJsDoc Toolkitの使い方を紹介するサイトです。JsDoc Toolkitは非常に優れたツールですが、まとまった日語の情報が少ないようなので何となく作ってみました。 このサイトの内容はあくまで管理人個人の理解に基づくものです。ご利用は自己責任でお願いします。 記載されている情報はバージョン 2.4.0 時点のものです。

    JsDoc Toolkitを使う!
  • JsDoc Toolkitによる開発効率向上を目指して (1/3)- @IT

    JavaScript開発を見直そう(前編) JsDoc Toolkitによる開発効率向上を 目指して 遠藤 太志郎 株式会社インテック ネットワーク&アウトソーシング事業部 2009/6/9 JavaScriptを使った開発で、ソースの保守性や再利用性までを視野に入れたドキュメントを残しているだろうか。Ajaxを使った高機能なWebサービスなど、JavaScriptによる開発規模は拡大している(編集部) システムエンジニアならば、JavaScriptという言葉は誰でも聞いたことがあるだろう。Webブラウザ上で動作し、主にWebブラウザのユーザーインターフェイスの向上を目的に使用されるプロトタイプベースのオブジェクト指向型スクリプト言語だ。 JavaScriptは、世に出てからしばらくの間は特にそれほど脚光を浴びるような技術ではなかったのだが、2005年にGoogleGoogle Map

  • 1