ITエンジニア/デザイナ向けにオープンソースを毎日紹介

DoxはJSDocに対応したソースファイルからドキュメントを生成するライブラリ。

DoxはJavaScript/node.js製のオープンソース・ソフトウェア。JavaScriptがWebアプリケーション構築の際のメイン言語として使われるようになっている。その結果起こっているのがJavaScriptのコードの大規模化だ。


トップページ

大規模になれば当然、複数人での開発体制になる。そうなれば情報の共有やコーディングスタイルの統一などが必須になる。その一端を担うのがAPIドキュメントだ。ソースコードからドキュメントを生成するソフトウェアがDoxだ。

DoxはJSDocもサポートしたソフトウェアで、コンソールからコマンドを実行するだけでHTMLベースのドキュメントを生成する。ドキュメントにはMarkdownの記法が利用できる。システムとしてはnode.jsを使っており、npmを使ってインストールが可能だ。


コード表示

生成されるのは一つのファイルになっており、JavaScriptを使って必要な部分だけを表示するようになっている。コードハイライトに対応している。関数へのリンクも可能とのこと、JavaScriptを使った開発が大型化してきたら導入すべきライブラリだろう。


MOONGIFTはこう見る

この手のドキュメントライブラリが登場するということは、開発規模が増しているということだろう。Webアプリケーションを開発する場合などはもちろん、jQueryを多用している場合にも導入した方が良いだろう。多人数での開発ではこの手のドキュメントがないと余計な混乱を生んでしまう。

一つのファイルとして生成されるのが個人的には好感が持てる。ファイルが分割されると検索が面倒でしかない。一覧で見られてコードと横並びで調べられるので、開発の際に手元にあると便利だろう。

Dox

visionmedia/dox at master - GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2