JSDoc vs YUIDoc比較
目的
JavaScriptソースからドキュメントを自動生成するツールを評価する。
評価の観点は、環境構築コスト、導入コスト、可読性の3点とし、
拡張性は必要性がなく除外する(標準で使えるツールである事が前提の為)。
結果
自動生成されたドキュメントの完成度がYUIDocの方が良く、YUIDocの利用が望ましい。
環境構築コスト(インストールから実行まで)
YUIDoc ★★★★☆
JSDoc ★★★☆☆
評価: 双方ともにインストールは同じレベルだが、JSDocは標準のテンプレートが残念な完成度であり、別のテンプレートに置き換える作業が別途必要でありYUIDocが良い。
導入コスト(コメントの追加)
YUIDoc ★★★☆☆
JSDoc ★★★★☆
評価:YUIDocは既存ソース中のコメントではドキュメント生成してくれず、@methodo等を追加する必要がありJSDocが良い。これは筆者のコメントの書き方に起因しており、注意が必要である。
可読性
YUIDoc ★★★★★
JSDoc ★★☆☆☆
評価:YUIDocは標準テンプレートで、ソース参照が可能で画面デザインも良いが、JSDocはソース参照できず、残念なデザインである。
備考:
筆者自身のスキル的な問題によりJSDocを使いこなせていない可能もあるが、簡単にそれなりのドキュメントが自動生成してくれるツールとしてはYUIDocが良いといえる。
自動生成ドキュメントの画面キャプチャー
YUIDoc
JSDoc
このブログへのコメントは muragonにログインするか、
SNSアカウントを使用してください。