.-- --

スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。
スポンサー広告 comment(-) trackback(-)
.03 2011

HeaderDocを使ってみる

Tasakiです。

2月になって急に暖かくなってきました。
この調子で春を迎えられると楽なんですけどねー。
巷ではインフルエンザが大流行中だとか、今年は花粉の飛散量が多くなりそうだとか、うれしくもない情報が飛び交っております。
くれぐれも体調管理には注意していきましょう。

で、今回のテーマは自動ドキュメント生成についてです。
Cをやってた身としましては、doxygenの方が一般的かもとは思いつつ、Apple推奨のHeaderDocも体験してみることにしました。
構文自体はdoxygenと大差ない感じです。
ただ、HeaderDocは名前の通り、ヘッダファイルに記述することを前提しています。(doxygenでも、基本はそうなんでしょうけど…)
それでもって一番の違いといえば、生成されたドキュメントでしょうね。
素のままではクールとは言いがたいものの、Appleのリファレンスライブラリに似たすっきりした外観のドキュメントが生成されます。

生成自体はいたって簡単で、iOS SDKをインストールしていれば、コマンドラインから、
headerdoc2html ファイル名
とすれば、HTML形式でカレントディレクトリに出力されます。
テンプレートHTMLを用意すれば、凝ったドキュメントに仕上げることも可能なようです。

肝心のコメントの書き方ですけど、
/*!
 @class NSString
 @superclass NSObject
 @discussion 文字列のコレクションクラス
*/
という感じで、それぞれの宣言部の直前または、ファイルの冒頭に書いていきます。

Xcodeの場合は、上部メニューのAppleScriptマーク(右の方の謎のマークです)のメニュー内にHeaderDocというカテゴリがありまして、そこからテンプレートを引き出せます。
これが結構便利なんですが、デフォルトのスクリプトが中途半端なので、私は多少書き換えました。
これはPerlで書かれてますので、個人的にはPerlの勉強にもなりました。
編集する場合は同メニューの「ユーザスクリプトを編集」を選択します。
ついでにショートカットキーも割充てておくとグッドです。

タグの詳しい説明などは、Appleの公式リファレンスに記載されています。
http://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/HeaderDoc/index.html


まだ触ったことがないという方は、ぜひ一度お試しを。



関連記事
スポンサーサイト

Comment

Post comment

  • comment
  • secret
  • 管理者にだけ表示を許可する

Trackback

trackbackURL:http://appteam.blog114.fc2.com/tb.php/171-b53cd3ae

ブログ内検索

関連リンク

製品情報

最新記事

カテゴリ

プロフィール

neoxneo



NEXT-SYSTEM iOS Developers Blog


  • UTO:
    カナダ版iPhone4Sは、マナーモードでシャッター音がならない…


  • Ehara:
    ...


  • Hayate:
    ...


  • Tasaki:
    Developer登録完了...したのはいいけど


  • Ueda:
    ...



リンク

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。