appledocのドキュメント作成を自動で行うようにする
プログラミング (iOS, JavaScript, Jenkins, Sikuli) とMacやiPhoneなどの話題が中心のブログ 前回の記事「appledocを使ってObjective-CソースをXcode Organizerで表示できるようにする」によって、Organizerでドキュメントを表示できるようになりました。 今回はこれを自動化して、コンパイル時やコミット時にドキュメント作成できるようにしてみます。紹介するのは次のような3つの方法です。 コンパイル時に作成 コミット時に作成 Jenkinsの利用 準備: plistの利用 前準備として、appledocを簡単に利用できるように設定します。 appledocはコマンドラインで指定した場所にAppledocSettings.plistがあれば、その設定を読み込みます。このファイルはkeyの部分にはコマンドラインオプションを指定す
Gentle Bytes - appledoc - Objective-C API documentation generator
About appledoc appledoc is command line tool that helps Objective-C developers generate Apple-like source code documentation from specially formatted source code comments. It's designed to take as readable source code comments as possible for the input and use comments as well as surrounding source code to generate visually appealing documentation in the form of HTML as well as fully indexed and b
Objective-C用のドキュメント作成ツールappledoc – なんてこったい
Objective-Cライブラリのドキュメント作成は今までDoxygenを使っていたのですが、もうすこしObjective-C用に適したドキュメント作成ツールがないか調べていたらappledocを見つけました。 その名の通り、Appleの公式リファレンス風のドキュメント生成をしてくれるソフトで、基本的にはdoxygenと似たような使い方をします。試しに使ってみたら結構よい感じでした。 Doxygenとの比較 Apple公式リファレンスに近いフォーマットで出力できるので、ユーザは多分読みやすい。 特にTasksでメソッドを機能ごとに分類できる。 インストールが面倒だったり、GUIアプリがなかったり、慣れていない人(特に技術者以外の人)には使いにくいかも。 まだ若干挙動があやしい部分もある気がする。 もはやドキュメント作成ツールの定番であるDoxygenに比べると、まだ歴史も情報もユーザも少な
ドキュメント自動生成のappledocを試してみたよ – morizotter blog
ドキュメントも綺麗なのをつくりたい！ appledocはXcodeのプロジェクトからクラスドキュメントを生成できるフレームワーク？です。Doxygenと似てるんじゃないかな。でも、Doxygenはちょっと面倒だし、なんかサイトも古くてちょっとしょぼいので、かっこいいappledocを試して見ることにしました！ ちょっと前に仕入れたappledocの情報を元に手元の環境に設定してみました。ただ開発するだけじゃなくてやっぱりドキュメントも綺麗に作りたいじゃない！ あと、コメントの書き方も統一化された一般的なもので行いたい。それにはやっぱりこういうフレームワークを利用するのが一番かなと！ 設定について 基本的にはtomaz/appledoc – GithubのREADMEが一番良いと思います。更に少しわかりやすく日本語で解説しているappledocを使ってObjective-CソースをXcode
ソースコードから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などに親しみのある人にはほとんど調べることなく書くことができ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
