lufiabb https://blog.hatena.ne.jp/lufiabb/ Plan 9とGo言語のブログ https://blog.lufia.org/ Go Exported from Qiita この記事はQiitaで公開されていました Goでドキュメントを書くとき、一般的にはGoDocを使うと思います。GoDocはシンプルにみえて、実際は色々な書き方をサポートしていますし、ブラウザで単純に表示する以外の読み方もあるので、一通りの方法をまとめてみました。 ドキュメントの書き方 GoDocではソースコードの中に、ある決まった形でコメントを書くと、そのコメントをドキュメントとして扱うことができます。具体的には、パッケージ、型、定数、構造体フィールド、関数・メソッドそれぞれの直前に、空行を入れずコメントを書きます。これらの前に改行を入れてしまうと、ただのコメントになってしまいます。 装飾につ… 190 <iframe src="https://hatenablog-parts.com/embed?url=https%3A%2F%2Fblog.lufia.org%2Fentry%2F2018%2F05%2F14%2F150400" title="GoDocドキュメントの書き方 - Plan 9とGo言語のブログ" class="embed-card embed-blogcard" scrolling="no" frameborder="0" style="display: block; width: 100%; height: 190px; max-width: 500px; margin: 10px 0px;"></iframe> https://cdn-ak.f.st-hatena.com/images/fotolife/l/lufiabb/20200328/20200328212429.png Hatena Blog https://hatena.blog 2018-05-14 15:04:00 rich https://blog.lufia.org/entry/2018/05/14/150400 1.0 100%