JSDoc Toolkit→JSDoc 3移行ガイド | BLOG - DeNA Engineering
こんにちわ、DeNA San Francisco の渋川と申します。エンジニアブログには初登場です。 JavaScriptのソースコードからAPIドキュメントを生成するツールには何種類かありますが、日本語の書籍やウェブサイトでも情報が得やすいこともあって、JSDocの系統が幅広く使われています。Google Closure Compilerも、JSDocを拡張したドックコメントをアノテーションとして読み込んで最適化します。 JSDocは長い期間メンテナンスされているオープンソースプロダクトです。初代はPerlで書かれたJSDoc 1です。これはすでにリポジトリも削除されています。現在最も使われているのが JSDoc Toolkit (JSDoc 2) です。弊社の ngCoreのドキュメント でも使用しています。 ただ、これも現在は機能追加を停止していて、後継プロダクトの JSDoc 3
JsDoc Toolkitを使ってJavaScriptのAPI仕様書を作る（環境構築から出力まで） | DevelopersIO
そんな訳で、JsDocについて少し調べたので、備忘録としてここに残しておくとします。 はじめに - JsDocについて Java開発者の方々ならば、JavaDocというのは馴染み深いを通り越して、もはや聞き飽きているかもしれません。同様にFlashのActionScriptにはASDoc、PHPにはPHPDocなるものがあります。ちょっとした規模のアプリケーションを開発すると、後々の保守を考慮してこういったAPI仕様書を作成し、後から「あれ、ここの処理って何の為にあるんだっけ？」となっても、ソースコードを直接追いかけることなく、概要を大まかに確認できるようにしておくのが慣例かと思います。※あくまで慣例です。実際にやっているかどうかは・・・(ry JsDocは、名前のとおりJavaScriptのAPI仕様書を指し、JavaDocと同様にHTMLドキュメント形式で出力されたもので、Webブラウ
MOONGIFT: » JavaScriptを一括して管理する「JS Builder」:オープンソースを毎日紹介
MOONGIFTをご覧いただいている方々は、もはやJavaScriptと聞いて単なるWebサイトの装飾だとは思ってはいないだろう。だが、各種ライブラリを扱ったり、JavaScriptを書く事はまだ個別ファイルベースでの話でしかないはずだ。 そろそろ他のファイルとの関連性を考えつつ、統合的に管理していくべきなのかも知れない（そのためにはIncludeのような仕組みが必要だと思うが）。そこでこれだ。 今回紹介するオープンソース・ソフトウェアはJS Builder、JavaScriptのプロジェクトビルダーだ。 JS BuilderはJavaScriptファイルをプロジェクトとして一括管理し、それらの一括したコメント除去処理およびJSDocを利用したドキュメント生成処理を行ってくれる。コメント除去したファイルは指定ディレクトリに生成されるので、テスト環境と本番環境との使い分けと言った利用法も考え
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
