現在、仕事でTypeScriptを使っていますが、 APIドキュメントが欲しくなってきて、 JavaDocとか、RDocとか、ScalaDocとか、みたいに 自動生成させたいなぁと思い、いろいろ試してみました。 試したツール jsdoc (npm) JsDoc Toolkit jsduck (gem) yuidocjs (npm) 試した結果 jsdoc : module以下のクラスのdocが生成できなかった JsDoc Toolkit : jsdocと同じ jsduck : docに定義されているタグが足りないとエラーになる yuidocjs : module以下のクラスもdoc生成できた と、いう訳で、yuidocjsを使ってドキュメント生成することにしました。 以下、環境構築手順と使い方についてメモしたいと思います。 環境 MacOSX 10.8.3 npm 1.2.14 types
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
既に先人の方が記事書いますが、気にせず記事書きます。 小ネタです。 参考にしたページ Pydoc - oogatta のブログ Windows用 pydoc.bat @echo off rem ------------------------ rem * Windows用pydoc rem 1. このファイルを%PYTHONHOME%にコピーする。 rem 2. %PYTHONHOME%を環境変数に登録する。 rem rem Linuxと同様にコマンドを使用できる。 rem ------------------------ set BAT_DIR=%~d0%~p0 python "%BAT_DIR%/lib/pydoc.py" %1 %2 oogattaさんのバッチファイルを参考に（というか、ほぼコピーですが）自分用にバッチファイルを作ってみました。 Pythonインストールフォルダに放り
ソースコードを見る上で、JavaDocやPHPDocument、RDocのように説明文がきちんと書かれていると見やすくて便利だ。しかし、書くのは良くとも後でHTMLを生成するために都度コマンドを実行するのは面倒に感じていた。 チュートリアルの構造化表示 そこでソースからそのまま読めるようになっていると便利そうだ。その目的に使えそうなのがこのソフトウェアだ。 今回紹介するオープンソース・ソフトウェアはCode Browser、ソースコードを見るのに便利なソフトウェアだ。 Code Browserはテキストエディタとして利用できるが、Code Browserで指定されるコメントの書き方をすると、ツリービューや複数ペインでの表示にするとソースを構造化して表示してくれるようになる。RDocのような4ペインでの表示もできる。 4ペイン表示 構造化した状態では関数を指定するとその関数だけを表示するよう
つい先日1.0.0RC1がリリースされたPHP_DocBlockGeneratorを使ってみました。 Creates the file Page block and the DocBlocks for includes, global variables, functions, parameters, classes, constants, properties and methods. Accepts parameters to set the category name, the package name, the author's name and email, the license, the package link, etc... PEARのページのDescriptionを見るだけで、かなり期待できそうです。以下、PHP5.2.3 on CentOS4.5で確認しています。 ま
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
