2008年10月22日水曜日

Objective-Cのコメントの書き方

Cと一緒

んなことたぁ分かってます

ドキュメント自動生成ツール

やっぱJavaDocのようなものは便利なわけで、Objective-CというかCocoaでもできないかなぁと探してます。以下はObjective-C対応のもの

  • HeaderDoc Appleのオープンソース。 多言語対応。
  • Doxygen 多言語対応
  • nudoc Objective-CとNuという言語に対応?

他にもKDocや、ドキュメントジェネレーターツールならDoxygenのサイトにもたくさん載ってるけど、まずは一番気になるHeaderDocを試してからだな。DoxygenはHTMLテンプレートを自由に変更できるなら見た目をもっと綺麗にして使いたいと、思った事を...すまないと思う!(ジャックバウアー)。

HeaderDoc8がサポートする言語

  1. Bourne shell (and Korn and Bourne Again)
  2. C Headers
  3. C source code
  4. C shell
  5. C++ headers
  6. Java
  7. JavaScript
  8. Mach MIG definitions
  9. Objective C/C++ headers
  10. Pascal
  11. Perl
  12. PHP

ADCがHeaderDocを使ってドキュメントを作成しているのなら、Cocoaアプリのクラスリファレンスは統一感が出るから使かおう。まだどんなアプリを作るかは考えてないけどw

追記:HeaderDocを試してみた

Xcodeのウィンドウとヘルプの間にある変なマークからHeaderDocを挿入するスクリプトがあるので試してみた。出力された例をSafariで確認できた。フレームで2つに別けられ、左がTOC(Table of contents)がコンテンツという感じだけど、APIリファレンスのようなデザインではない。配色は落ち着いてていい感じ。まだ試してないけど、他のクラスへのリンクとか、各ファイルの一覧とかは作成されるのかなぁ?。CSSはtoc.htmlにまとめて書かれていたり、spanのstyle属性でフォントが指定されている。テンプレートがあるならAPIリファレンスっぽいデザインに変えるのはCSSだけでもできそうな感じはするけど、提供されてるかは調べてない。日本語は普通に表示された。

0 件のコメント: