/** * Output JSDoc: typeof message === "string"'); console.Chrome の開発者ツールであれば関数の呼び出しと assert 箇所をコンソールから確認できるので不正な値を指定した処理を修正するためのヒントになる。 環境構築と注意点 jsdoc-to-assert は本体と Babel plugin/preset 版が提供されている。plugin が Bab
JSDocをassertに変換するライブラリとそれを使ったBabelプラグインを書きました。 azu/babel-plugin-jsdoc-to-assert: Babel plugin for jsdoc-to-assert. azu/jsdoc-to-assert: JSDoc to assert ライブラリのjsdoc-to-assertの方は、JavaScript ASTのコメントからassertの文字列を作り出すだけのシンプルなものです。 実際に使う場合は、Babelのプラグインとしてbabel-plugin-jsdoc-to-assertを使い、コードを変換してランタイムassertを追加させます。 やっていることとしては、FlowTypeをランタイムチェックするbabel-plugin-typecheckのJSDoc版とも言えます。 babel-plugin-typechec
Tracking JavaScript Annotations Apr 6, 2014 3 min read #esprima #javascript #jstools #web One of the interesting features of Esprima is to retrieve every comment inside a JavaScript source. Even better, each comment can be linked to the related syntax node. This is very helpful (like in the case of JSDoc) since any additional inf
Documentation for FusionCharts, FusionTime and FusionExport FusionCharts Suite XT FusionExport FusionTime
A JavaScript parser for Google Closure Compiler and JSDoc type expressions. Catharsis is designed to be: Accurate. Catharsis is based on a PEG.js grammar that's designed to haIt uuite to verify the parser's accuracy. Fast. Parse results are cached, so the parser is invoked only when ble. Catharsis can convert a parse result back
こんにちわ、DeNA San Francisco の渋川と申します。エンジニアブログには初登場です。 JavaScriptのソースコードから本語の書籍やウェブサイトでも情報が得やすいこともあって、JSDocの系統が幅広く使われています。Google Closure Compilerも、JSDocを拡張したドックコメントをアノテーションとして読み込んで最適化します。 JSDocは長い期間メンテナンスされているオープンソースプロダクトです。初代はPerlで書かれたJSDoc 1です。これはすでにリポジトリも削除されています。現在最も使われているのが JSDoc Toolkit (JSDoc 2) です。弊社の ngCoreのドキュメント でも使用しています。 ただ、これも現在は機能追加を停止していて、後継プロダクトの JSDoc 3
JsDocとは、JavaDocライクなドキュメント作成ツールです。 JavaScriptは非常に柔軟な言語であるため、ドキュメントなしに他人のコードを読むことはかなり骨の折れる作業です。 しかし、いちいちドキュメントを書く作業もまた骨の折れる作業です。 JsDocはドキュメントを書く手間を大幅に低減してくれます。
Jsdoc2-template-bootstrap : Beautiful Template with Bootstrap for JsDoc2.Demo Demo is here. Install To produce output files you must use a template to ftemplate you wish to use. java -jar jsrun.jar app/run.js myscripts/ -t=templates/JsDoc2-Template-Bootstrap See JsDoc document, if you want more inftemplate
JavaScriptで大規模開発をされているみなさま、ドキュメントジェネレータは活用してますか？ ソースコードにコメントを入れておくと、自動でHTMLに仕上げてくれるアレのことです。 /** * 足し算した結果を取得します。 * * @param {Number} num1 * 足される数 * @param {Number} num2 * 足す数 * @return {Number} * 結果 */ function add(num1, num2) { return num1 + num2; } JavaScript向けのツールで有名なのが「JsDoc」。 そのまま使うと無難なデザインのHTMLが出来上がってしまいますが、テンプレート機能を使って自由に拡張できます。 そこで今日ご紹介するのが…！ JsDoc2-Template-Bootstrap いかがでしょう、Twitter Bo
正宗です。ものすごく今さらな事を知ったのでおおはしゃぎで書き留めておきます。いかに今までまともにJSDocを書いていなかったか。 私が主に JavaScriptを書くときに使っているWebStJSDocをきちんと書くようにすると、JavaScriptの型をなかなか強力にサポートしてくれるようになりました。コードの補完機能なんかもかなり精度が上がってくるので、結果的にコーディングも速くなるのではないでしょうか。 私は特に普段はActionScript3を書く機会が多く、ご存じのとおりActionScript3は型を明示できる言語なのでFlashBuilderやFlashDevelop、FlashCS5などのIDEに備わっている補完機能に頼り切ってコーディングしていました。そのスタイルのままJavaScriptのほうの開発を行うと、今まではJavaScriptで厳密に型を明示できないこ
Check out my book (free online): “Speaking JavaScript”. Updated version of this blog post: chapter “JSDoc: Generating JSDoc’s JSDoc. I learned (er remembered) a few things from reading it myself! via @rauschma 2ality.com/2011/08/jsdoc-intro.html JSDoc is the de facto standard for documenting JavaScrip
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
