Inch CI# Inch CI Inch CI is down after my server died (again). Badges should be working, but I will need some time to restore the DB from backups. ~@rrrene
JavaScript対応APIドキュメント生成ツールのまとめ
JavaScriptにもJavaDocのようなコメントからAPIドキュメントを生成するツールがいろいろとあるため、どのようなものがあるか少し調べて見ました。基本的なコメントの書き方は大体がJSDocと共通しているので、特に言及がなければそのような書き方が通るものが多いです。 JsDoc Toolkit JSDoc(開発停止)の後継であるため最も有名だと思います。 現在はver2で機能追加のリクエストは停止されていますが、JSDoc 3が開発中となっているそうです。 情報量もそこそこあると思うので、APIドキュメント生成ツール関係について調べる時に参考になる。 Closure Compilerなどいろいろなところで使われていたりします。 -JsDoc Toolkitを使う！ – トップページ YUI Doc YahooのYUI Libraryで使用されているドキュメント生成ツールです。 Py
コードリーディングにDoccoを使うと捗るかもしれない件
Doccoは、CoffeeScriptにコメントをつけてドキュメントを出力できるパッケージです。コードとコメントを左右に表示されるスタイルです。コメントにはMarkdownが使えます。 インストール インストールはnpm。追加でPygmentsが必要です。 $ npm install -g docco $ sudo easy_install Pygments 使い方 先日のエントリーで紹介したブログアプリCoffee-Boxを例にコメントを書くとこうなります。 (CoffeeBoxの紹介は 『Node.js「脱」初心者！CoffeeBoxでブログの作り方を学ぼう！』を参照してください） # ***server.coffee*** は、Coffee-Boxのエントリーポイントです。 # [express](http://expressjs.com/)を読み込みます。 express = re
YUIDocを使ってみたよ - 四角革命前夜
JavaScript向けのドキュメントジェネレータというと、JSDoc toolkitとかDoccoなどがありますが、YUIDocが程よく手軽な感じで使ったこともなかったので使ってみました。 昔はJavaかなんかで作られてた気がするのですけど、いまではnpmモジュールになってるのですね。node.js + npmが入ってるならとってもインストールはとっても簡単。 インストール npmからインストールします。 $ npm install -g yuidocjs でインストールするとよいかと。今回はグローバルにインストールしたくなかったので $ npm install yuidocjs でインストールして $ ./node_modules/.bin/yuidoc で使うことにします。 適当なコードを書く 適当なJavaScriptのコードを書きます。 index.js /** * Classク
JavaScriptのAPIドキュメント生成ツールを調べてみたら、YUIDocが割とよかった - terurouメモ
JavaScriptのAPIドキュメント生成ツール（いわゆるjavadocみたいなもの）を使いたくなったので、色々調べてみた。 jsdoc3 使い方が間違ってると指摘されたので、訂正エントリ書きました → 【訂正エントリ】jsdoc3の使い方が間違ってると指摘を受けたので再評価した - DenkiYagi JavaScriptのAPIドキュメント生成ツールは現在もjsdoc系が主流のようなので、その最新系統のjsdoc3をまず試してみた。 jsdoc3/jsdoc · GitHub zipをダウンロードして展開すると、JREさえインストールされていればすぐに使える（Rhinoのjarが同梱されている）。 で、実際に使ってみたのだが、以下のように即時関数内にドキュメントコメントを書いているケースではドキュメントが正常に生成されない。 /** @module SampleModule */ v
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
enja-oss
JsDoc Toolkitを使う！
Maruta