Beginning comfortable documentation with jenkins and doxygen ( public )
•
1 j'aime•3,017 vues
Recommandé
Contenu connexe
Tendances
Tendances (20)
En vedette
En vedette (12)
Beginning comfortable documentation with jenkins and doxygen ( public )
- 3. Agenda • ぼくがやってたどきゅめんてーしょん • 今やってるドキュメンテーション • Doxygen • Jenkins • Jenkins Git Plugin + Gitlab Hooks 3Thursday, April 18, 13
- 6. もしソフトウェア開発の現場 にドキュメントがなかったら きっとこんなやりとりが日常茶飯事… • 「この処理なさそうだったので作りました！」 ➡その実装３つ目… • 「この引数って整数ならなんでもいいんですよね！」 ➡負数はやめてください… • 「戻り値0以外は全部失敗ですよね！」 ➡あのリターンコード一覧がここに… 6Thursday, April 18, 13
- 8. SIer時代に書いたCoolなドキュメント（再現） Point! Coolなクラス名 Point! キチンとソースコード全文貼付け Point! 承認印大事 Point! メソッド名もCool 8Thursday, April 18, 13
- 9. SIer時代に書いたCoolなドキュメント（再現） Point! 役割の分からないクラス名 Point! コピペ必須なのでリファクタリングしなくなる Point! 承認必須なので更新しなくなる Point! メソッド名も何するのか不明 これ…あかんやつや…… 9Thursday, April 18, 13
- 10. そこで 10Thursday, April 18, 13
- 12. なにができるの？ • コメントからHTMLドキュメント生成 • HTML以外も色々作れる（らしい）よ！ • RDocやJavadoc的なアレ ➡C/C++/ObjCに対応 • 他の言語も色々対応してる（らしい）よ！ Point! 12Thursday, April 18, 13
- 15. $ doxygen -g $ doxygen この２行で結構だいじょぶ！ 15Thursday, April 18, 13
- 17. なにができるの？ • CI（継続的インテグレーション）ツール • 任意のjobを実行してくれる • ビルド／パッケージング ➡ シェルスクリプト • 色々なタイミングで実行してくれる • svn commit／git pushされたとき ➡ HTTPリクエスト来たときに ➡ Pluginたくさん Point! Point! Point! 17Thursday, April 18, 13
- 18. Jenkins Git Plugin + Gitlab Hooks 18Thursday, April 18, 13
- 20. Pluginインストール Doxygen Plugin Git Plugin 20Thursday, April 18, 13
- 25. Have a Comfortable Day! with entertainment 25Thursday, April 18, 13