ソースコードからApple標準スタイルのAPIドキュメントを生成するappledocの書き方 | DevelopersIO
サンプルクラスの作成 プロジェクトを作成したら、コメントを試すためのクラスとしてNSObjectを継承したSampleObjectを作成しましょう。 コメントの書式 appledocでは、以下で紹介する特別な書式で書かれたコメントからドキュメントを抽出します。また、もともとHeaderDocやDoxygenの書式で書かれた書式にも対応しているため、簡単に移植できます。 複数行のコメント appledocでは「/** コメント */」のように/(スラッシュ)１つと*(アスタリスク)２つで始まり、*(アスタリスク)１つと/(スラッシュ)１つで終わるコメントを解析対象とします。 /** コメントをかくぜぇ */ 試しにSampleObject.hのクラス定義の上に以下のように書いてみましょう。 SampleObject.h #import <Foundation/Foundation.h> /*
appledocでドキュメント生成 - Qiita
こんにちは、iOS Advent Calendar / Aug.28日目担当の@mtgtoです。 今日はObjective-Cのソースコードからドキュメントを生成するappledocというツールについて書こうと思います。JavadocやdoxygenのObjective-C版といったところでしょうか。 まずはappledocを見たことのない人のために、実例を見ていただきましょう。 AFNetworkingのドキュメント 一見するとApple謹製のドキュメントのようなデザインですが、実はこれ今回ご紹介するappledocによりソースコードのコメントから自動生成されたものなのです。 サンプル まずはどのように書けばいいのかということで、自分のプロジェクトの中からドキュメント化してあるメソッドのサンプルを持って来ました。 Javadocなどに親しみのある人にはほとんど調べることなく書くことができ
Apple風ドキュメント自動生成ツール「appledoc」をもっと簡単に使うTips - Qiita
appledocのコマンドを入力するのが面倒なので、ちょっと簡単な方法を考えてみました。 やりたかったこと 引数入力なしで実行したい。 プロジェクトごとに設定したい。 自動生成したい。 まずはappledocの簡単な説明 Appleのドキュメントのようなこのページを簡単に出力できるツールがappledocです。普通にXcodeを利用して作成したプロジェクトがあれば、コメントを少し意識するだけで簡単にそれっぽいドキュメントが生成できます。使い方は、 所定の書式のコメントをファイルに書いておく appledocコマンドを引数とともに入力する。 というだけ。簡単といえば簡単です。ただし、ドキュメントに出力するときに引数で設定できる項目が多く、面倒に感じます。もちろん引数を間違えると出力できません。そこで、自分がよく使う設定をplistで書きだしておいて、プロジェクトごとに自分の好きなように手を加
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
