Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Beginning comfortable documentation with jenkins and doxygen ( public )

2,679 views

Published on

  • Be the first to comment

Beginning comfortable documentation with jenkins and doxygen ( public )

  1. 1. JenkinsとDoxygenではじめる快適ドキュメンテーション@mazgi(株)ドリコム 社内勉強会LT資料1Thursday, April 18, 13
  2. 2. 改めて自己紹介• @mazgi• ドリコムでスマートフォン関係の開発➡前職はSIer(エスアイアー)Point!2Thursday, April 18, 13
  3. 3. Agenda• ぼくがやってたどきゅめんてーしょん• 今やってるドキュメンテーション• Doxygen• Jenkins• Jenkins Git Plugin + Gitlab Hooks3Thursday, April 18, 13
  4. 4. さっそくですが4Thursday, April 18, 13
  5. 5. ドキュメントって大事ですよね!5Thursday, April 18, 13
  6. 6. もしソフトウェア開発の現場にドキュメントがなかったらきっとこんなやりとりが日常茶飯事…• 「この処理なさそうだったので作りました!」➡その実装3つ目…• 「この引数って整数ならなんでもいいんですよね!」➡負数はやめてください…• 「戻り値0以外は全部失敗ですよね!」➡あのリターンコード一覧がここに…6Thursday, April 18, 13
  7. 7. だから書いてました7Thursday, April 18, 13
  8. 8. SIer時代に書いたCoolなドキュメント(再現)Point! Coolなクラス名Point! キチンとソースコード全文貼付けPoint! 承認印大事Point! メソッド名もCool8Thursday, April 18, 13
  9. 9. SIer時代に書いたCoolなドキュメント(再現)Point! 役割の分からないクラス名Point! コピペ必須なのでリファクタリングしなくなるPoint! 承認必須なので更新しなくなるPoint! メソッド名も何するのか不明これ…あかんやつや……9Thursday, April 18, 13
  10. 10. そこで10Thursday, April 18, 13
  11. 11. Doxygen11Thursday, April 18, 13
  12. 12. なにができるの?• コメントからHTMLドキュメント生成• HTML以外も色々作れる(らしい)よ!• RDocやJavadoc的なアレ➡C/C++/ObjCに対応• 他の言語も色々対応してる(らしい)よ!Point!12Thursday, April 18, 13
  13. 13. こんなソースコメントからドキュメント作ってくれる!13Thursday, April 18, 13
  14. 14. 難しいんでしょ?でも、     14Thursday, April 18, 13
  15. 15. $ doxygen -g$ doxygenこの2行で結構だいじょぶ!15Thursday, April 18, 13
  16. 16. Jenkins16Thursday, April 18, 13
  17. 17. なにができるの?• CI(継続的インテグレーション)ツール• 任意のjobを実行してくれる• ビルド/パッケージング➡ シェルスクリプト• 色々なタイミングで実行してくれる• svn commit/git pushされたとき➡ HTTPリクエスト来たときに➡ PluginたくさんPoint!Point!Point!17Thursday, April 18, 13
  18. 18. Jenkins Git Plugin+Gitlab Hooks18Thursday, April 18, 13
  19. 19. ではサクっと構築19Thursday, April 18, 13
  20. 20. PluginインストールDoxygen PluginGit Plugin20Thursday, April 18, 13
  21. 21. jobを作るシェルスクリプトでDoxygen実行出力先を設定ファイルから取得21Thursday, April 18, 13
  22. 22. HTTPリクエストを送ると、jobが実行される22Thursday, April 18, 13
  23. 23. GitLabにHook登録23Thursday, April 18, 13
  24. 24. Doxygenドキュメントの永続リンクありこれ…気持ちいいやつや!24Thursday, April 18, 13
  25. 25. Have a Comfortable Day!with entertainment25Thursday, April 18, 13

×