#jsdoc

L’agilité ne permettant pas de passer beaucoup de temps à travailler sur la conception et la doc, il convient d’être le plus efficace possible. En node (et JS) le manque de typage des données impose une documentation la plus exhaustive possible, avec les structures d’objets attendus lorsque cela est nécessaire. (un simple json au final)

Vu que mes développeurs sont des fainéants, et c’est bien normal, faire de la doc ça les saoule… autant leur éviter de faire de la saisie en double, et à moi aussi. Vu qu’il y avait déjà dans le code des annotations façons javadoc, j’ai fouillé un peu dans les libs de génération de doc :

-> YUIdoc : trop orienté objet/API. Pas pour nous donc (et devoir annoter les noms de méthodes, bisarre…)

-> Doxx : a priori, parfait ! Le fait de garder le code source est un plus intéressant, vu que l’on ne publie pas une API. Excellent template par défaut, bien que la navigation pêche un peu, un regroupement par folder aurait pu être facile pourtant…

-> Dox-foundation : Dox se présentant comme un refactoring complet de dox-foundation, la curiosité m’a poussé à aller tester ce dernier :

PAF! En une ligne de commande, ma doc est générée, avec les fonctions groupées par fichier, et toujours la possibilité de voir le code source… inutile de chercher plus loin, ça me va, je passe à l’IC ! Publication automatisée de la doc :

Dans jenkins, j’ajoute une étape “execute shell script” à mon build, avec la commande “dox-foundation —source src —target docs -i test”.

Via le plugin “Publish HTML reports” j’associe la doc générée à une addesse permanente sur mon serveur.

J’ajoute le lien permanent de la doc, générée à chaque build, dans notre outil de doc interne (Confluence)

JSer.info #122 - JSHint 2.0.0リリース。 JSHint 1.0.0がでたのも今年ですが、ES5をデフォルトに変更、ES.nextの内容のサポート等かなり積極的に機能を追加していると思います。 またJSHint 自体もrapid releaseを取り入れてアップデートしていくようです。

JSDoc Toolkit→JSDoc 3移行ガイド - Technology of DeNAでは、JSDoc 2とJSDoc3の相違点などがまとめられています。 Use JSDoc: Indexのドキュメントに大体が載っています。 WebStorm等のエディタもJSDocをサポートしているもが増えているので補完にも優位に働くと思います。

引数に渡すオブジェクトのプロパティの定義について載ってない気がするのはJSDoc標準ではないのかな。

javascript - How to describe "object" arguments in jsdoc? - Stack Overflow

ヘッドライン

JSHint - JSHint 2.0.0 is out http://jshint.com/blog/2013-05-07/2-0-0/

JavaScript Tools デバック

JSHint 2.0.0リリース. 後方互換性がない部分も含まれる。 ES5 modeがデフォルトに(オプションでES3モードがある)、ES6のものも一部サポート、コメントで挟んだ部分を警告対象から外すpragmaの追加等

JSHint 2.0 公開（翻訳） | 黒くないすべてのものはカラスではない

jQuery 1.10 Beta 1 Released | Official jQuery Blog http://blog.jquery.com/2013/05/09/jquery-1-10-beta-1-released/

jQuery ReleaseNote

jQuery 1.10 Beta 1 リリース。

jQuery Migrate 1.2.1 Released | Official jQuery Blog http://blog.jquery.com/2013/05/08/jquery-migrate-1-2-1-released/

jQuery plugin ReleaseNote

jQuery Migrate 1.2.1リリース。 1.2.0のsecurity fixで発生したリグレッションの修正

Dojo 1.9 Released! | The Dojo Toolkit Blog http://dojotoolkit.org/blog/dojo-1-9-released

JavaScript library ReleaseNote

Dojo 1.9リリース。

RequireJS 2.1.6 Released ~ James Burke http://jrburke.com/2013/05/10/requirejs-2.1.6-released/

JavaScript ReleaseNote

RequireJS 2.1.6 リリース。 SourceMapサポート強化

zlib.js 0.1.6 をリリースしました : document http://blog.livedoor.jp/imaya_js/archives/6504789.html

JavaScript 圧縮解凍 library ReleaseNote

zlib.js 0.1.6 リリース。 ビルドの最適化、ビルドオプションの追加、Raw 形式の追加

WebMatrix 3 を発表 - Windows Azure Japan Team Blog (ブログ) - Site Home - MSDN Blogs http://blogs.msdn.com/b/windowsazurej/archive/2013/05/08/announcing-webmatrix-3.aspx

windows software IDE

WebMatrix 3 リリース

アーティクル

JSDoc Toolkit→JSDoc 3移行ガイド - Technology of DeNA http://engineer.dena.jp/2013/05/migration-from-jsdoc2-to-jsdoc3.html

JavaScript document

JSDoc2 から3に移行するときに対応ガイド。 JSDoc 3で導入されたアノテーション等の解説。Markdownを使ったドキュメントの取り込み等について

Debugging & Profiling Node.js https://gist.github.com/balupton/3944017

node.js Tools まとめ

Node.js周りのプロファイルツールやデバッグツールの導入方法まとめ

generators in v8 -- wingolog http://wingolog.org/archives/2013/05/08/generators-in-v8

JavaScript

V8に実装されたES6 generator(yeild)のC# awaitのような使い方について。 Q.asyncのgenerator functionの対応 https://github.com/kriskowal/q/pull/288

Google Chromeに入ったジェネレータとPromiseで非同期処理に革命が起きた - 素人がプログラミングを勉強していたブログ

Authoring & development workflow - Chrome DevTools — Google Developers https://developers.google.com/chrome-developer-tools/docs/authoring-development-workflow

JavaScript Chrome デバック

Chrome Dev Toolsの使いこなすと便利機能の紹介。 検索やナビゲーション/フィルタ、編集機能と保存とファイル監視、スニペット機能、自動保存/更新の拡張機能について

SassのデバッグにSource Mapsを使うべきたくさんの理由 | Dress Cording http://dresscording.com/blog/sass/sass_sourcemaps.html

Sass Tools

Sass、CompassとSource Mapsでのデバッグについてやsassコマンドのオプションについて。 Chromeで編集して保存するTincr等の拡張について

スライド、動画関係

Model View Madness http://www.slideshare.net/anm8tr/model-view-madness

JavaScript MVC library スライド

JavaScriptのMV*ライブラリで、それぞれModel、View、Controller、Otherが何を処理しているかをまとめながら紹介してるスライド

Preventing XSS with Content Security Policy http://benvinegar.github.io/csp-talk-2013/#1

CSP XSS

Third-party JavaScript著者の人によるXSSとCSPについてのスライド。 CSPのヘッダルールと抑制される機能の解説、CSP reportingについても

設計ポイントの 比較で知る Backbone.js // Speaker Deck https://speakerdeck.com/utwang/she-ji-pointofalse-bi-jiao-dezhi-ru-backbone-dot-js

backbone.js スライド

RailsとBacnboneを比較しながら、Backboneの設計のポイント。 Input/Output、Router、View、Model それぞれについて解説してるスライド

サイト、サービス、ソフトウェア関係

JavaScript, aka. Web ECMAScript http://javascript.spec.whatwg.org/

JavaScript DOM spec

使うべきではない機能だが、色々なウェブブラウザに実装されてる非標準なものを互換性のために標準化する目的の仕様 訳: http://www.hcn.zaq.ne.jp/___/WEB/javascript-ja.html

ウェブ関連仕様 日本語訳（ www.hcn.zaq.ne.jp/___/WEB/ ） http://www.hcn.zaq.ne.jp/___/WEB/

WebAPI W3C 翻訳 ECMA JavaScript

W3C/WHATWG等のDOM/JavaScript関連周りの仕様書翻訳 DOM4/TypedArray/CSP/Web Workers/Navigation Timing API等

Ghostlab http://www.vanamco.com/ghostlab/

browser Tools software mac

複数のブラウザの操作を同期してテストするMacアプリ

ツール、ライブラリ関係

KapIT/observe-shim · GitHub https://github.com/KapIT/observe-shim/

ECMA JavaScript library

ES HarmonyのObject.observeのshim(polyfill)

MPEG1 Video Decoder in JavaScript - PhobosLab http://phoboslab.org/log/2013/05/mpeg1-video-decoder-in-javascript

JavaScript 動画 library

JavaScriptで書かれたMPEG1動画デコーダーライブラリ

ramesaliyev/EasyWebWorker · GitHub https://github.com/ramesaliyev/EasyWebWorker

JavaScript library

WebWorkerのコミュニケーションを補助するライブラリ。 Browser <-> Worker それぞれ関数を呼び出す、値の受け渡し、console.logのalias等

doug-martin/promise-utils · GitHub https://github.com/doug-martin/promise-utils

JavaScript library

Promiseな感じで使えるArray#map等のCollection系のUtilライブラリ。

書籍関係

Amazon: Node.js in Practice [Paperback]: Alex R. Young, Marc Harter http://www.amazon.com/o/ASIN/1617290939/book042-22/ref=nosim

node.js book

2013年11月28日 発売 Node.jsについての書籍 http://www.manning.com/young/

O'Reilly Japan - JavaScriptデザインパターン http://www.oreilly.co.jp/books/9784873116181/

JavaScript デザインパターン book

2013年05月25日 発売 Addy Osmani著のJavaScriptデザインパターン本の翻訳

Amazon: AngularJS in Action [Paperback]: Brian Ford, Lukas Ruebbelke http://www.amazon.com/o/ASIN/1617291331/book042-22/ref=nosim

JavaScript AngularJS book

2013年11月28日発売 AngularJSについての書籍