beginning comfortable documentation with jenkins and doxygen ( public )

JenkinsとDoxygenではじめる快適ドキュメンテーション

@mazgi

（株）ドリコム 社内勉強会LT資料

1Thursday, April 18, 13

改めて自己紹介

• @mazgi

• ドリコムでスマートフォン関係の開発➡前職はSIer（エスアイアー）Point!

2Thursday, April 18, 13

Agenda

• ぼくがやってたどきゅめんてーしょん

• 今やってるドキュメンテーション

• Doxygen

• Jenkins

• Jenkins Git Plugin + Gitlab Hooks

3Thursday, April 18, 13

さっそくですが

4Thursday, April 18, 13

ドキュメントって大事ですよね！

5Thursday, April 18, 13

もしソフトウェア開発の現場にドキュメントがなかったらきっとこんなやりとりが日常茶飯事…

• 「この処理なさそうだったので作りました！」

➡その実装３つ目…

• 「この引数って整数ならなんでもいいんですよね！」

➡負数はやめてください…

• 「戻り値0以外は全部失敗ですよね！」

➡あのリターンコード一覧がここに…

6Thursday, April 18, 13

だから書いてました

7Thursday, April 18, 13

SIer時代に書いたCoolなドキュメント（再現）Point! Coolなクラス名

Point! キチンとソースコード全文貼付け

Point! 承認印大事

Point! メソッド名もCool

8Thursday, April 18, 13

SIer時代に書いたCoolなドキュメント（再現）Point! 役割の分からないクラス名

Point! コピペ必須なのでリファクタリングしなくなる

Point! 承認必須なので更新しなくなる

Point! メソッド名も何するのか不明

これ…あかんやつや……9Thursday, April 18, 13

そこで

10Thursday, April 18, 13

Doxygen

11Thursday, April 18, 13

なにができるの？• コメントからHTMLドキュメント生成

• HTML以外も色々作れる（らしい）よ！

• RDocやJavadoc的なアレ

➡C/C++/ObjCに対応

• 他の言語も色々対応してる（らしい）よ！Point!

12Thursday, April 18, 13

こんなソースコメントから

ドキュメント作ってくれる！13Thursday, April 18, 13

難しいんでしょ？でも、　　　　　

14Thursday, April 18, 13

$ doxygen -g$ doxygen

この２行で結構だいじょぶ！

15Thursday, April 18, 13

Jenkins

16Thursday, April 18, 13

なにができるの？• CI（継続的インテグレーション）ツール

• 任意のjobを実行してくれる

• ビルド／パッケージング

➡シェルスクリプト

• 色々なタイミングで実行してくれる

• svn commit／git pushされたとき

➡ HTTPリクエスト来たときに

➡ Pluginたくさん

Point!

Point!

Point!

17Thursday, April 18, 13

Jenkins Git Plugin+

Gitlab Hooks

18Thursday, April 18, 13

ではサクっと構築

19Thursday, April 18, 13

Pluginインストール

Doxygen Plugin

Git Plugin

20Thursday, April 18, 13

jobを作る

シェルスクリプトでDoxygen実行

出力先を設定ファイルから取得

21Thursday, April 18, 13

HTTPリクエストを送ると、

jobが実行される22Thursday, April 18, 13

GitLabにHook登録

23Thursday, April 18, 13

Doxygenドキュメントの永続リンクあり〼

これ…気持ちいいやつや！24Thursday, April 18, 13

Have a Comfortable Day!

with entertainment

25Thursday, April 18, 13