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

appledocはObjective-CのコードからHTMLリファレンスを生成するソフトウェア。

appledocはObjective-C製のオープンソース・ソフトウェア。外部のライブラリやフレームワークを使って開発していると、そのコードの中身を見て動作を確認する方が早くなる。そんな時に使えるのがAPIのリファレンスだ。リファレンスを使うとあたりをつけるのが早くなる。


生成されたドキュメント

そのためシステム開発においてはソースコードからリファレンスを生成する系統のライブラリに人気が集まる。Objective-Cであればappledocを使ってみよう。

appledocはAppleのリファレンス風のHTMLファイルを生成するツールだ。JavaDocのようにコードに元々記述しなければならないが、その結果はとても素晴らしい。左側にツリーが、右側にコードリファレンスが表示される。必要に応じてクリッカブルになっている。


ヘルプ

HTMLだけでなくXcode向けのドキュメントも生成される。WebブラウザからだけでなくIDEからもリファレンスが簡単に参照できる。出力方式のカスタマイズも容易とのことだ。コードから全て当たるよりも見やすく、探しやすいリファレンスは便利だ。社内開発のナレッジ共有にも役立つことだろう。


MOONGIFTはこう見る

この手のコードからドキュメントを生成するツールは数多くある。○○Docと命名されることが多い。Java、PHPをはじめ各言語向けに存在する。コードの中に埋め込めるので分かりやすいのが利点だが、時々内容が乖離していることがあるので注意が必要だ。

アプリ開発の結果、ドキュメントを納品する場合にも使えるし、オープンソースとしてライブラリを公開する際にも利用できる。何よりAppleのドキュメント風なので見慣れている人も多いのが利点だ。Objective-C開発の際には手元においておきたいソフトウェアだ。

appledoc | Gentle Bytes

tomaz/appledoc - GitHub

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2