Fukuoka.go#2 LT資料 Hello GoDoc!

1. Hello GoDoc!
GoDocのためのコメントフォーマット
Fukuoka.go #2 - 2014/8/21
@laco0416

2. About Me
Suguru INATOMI a.k.a. laco0416
●
21歳 学生
●
Go歴半年くらい 主にGAE/Go
●
福岡から来ました
●
来年から東京にいます

3. Agenda
●
What's GoDoc?
GoDocの紹介と使い方
●
Structure of GoDoc
GoDocの構造について
●
How to make GoDoc
GoDocの作り方
●
Other
その他の機能

4. GoDoc

5. Example

6. What's GoDoc?
Goのオープンソースパッケージのドキュメントホスティングサービス
●
GitHub
●
Bitbucket
●
LaunchPad
●
Google Project Hosting
Goのソースコードからドキュメントを自動生成してくれる
GoDocにあるパッケージはすべて "go get"able

7. GoDocの登録
リポジトリのURLを検索するだけ
GoDocの削除
●
リポジトリの削除を自動反映
●
運営にメールで削除申請

8. Structure of GoDoc
Summary

9. Structure of GoDoc
Index

10. Structure of GoDoc
Constants & Variables

11. Structure of GoDoc
type

12. Structure of GoDoc
func

13. How to make GoDoc
Basic conversion

14. How to make GoDoc
Result

15. How to make GoDoc
Embed code
半角スペース2個のインデントで埋め込みコード化

16. How to make GoDoc
Result

17. IDEAだとけっこう簡単にできる

18. Better GoDoc
Example
●
Example用にファイルを分ける
●
ファイル名は”○○_test.go”
●
メソッド名は”Example△△”
●
{}の中が呼び出し例として出力される
●
"//Output:"のあとに応答(普通は戻り値)を書く

19. Result
実際しょぼい
Example書いてるパッケージなかなか無い

20. Result
Playgroundに飛べるのは組み込みパッケージだけ

21. Other
GoDoc Badge

22. GoDoc Badge
GitHubでよく見るやつ

23. ご静聴ありがとうございました