Goで非推奨(Deprecated)や撤回(Retracted)を明示する方法 - Plan 9とGo言語のブログ

2023/10/12 22 users deprecated 撤回 段落 関数 Go言語

最近のGoには、関数やパッケージを非推奨と扱う方法があります。まとまっていると便利かなと思うので、種類ごとにまとめてみました。GoDocコメントを多用するので、GoDocを書き慣れていない場合は以下も参考にしてください。 blog.lufia.org 関数と型を非推奨にする 関数コメントに、// Deprecated: ではじまる段落を追... 続きを読む

Go Tips連載3: GoDocの読み方 | フューチャー技術ブログ

2020/05/21 11 users README インタフェース リファレンス リポジトリ 構造体

今回は、GoDocについて取り上げます。 長いので3行にまとめると GoDocのリファレンスはライブラリにとっては一次情報だが、使い方などはリポジトリのREADMEに書かれることも多い 構造体やインタフェースは、リファレンスだけを見ても使い方がわからないこともあるので、分からないからといって落ち込まないでください サ... 続きを読む

Go1.14のcontextは何が変わるのか - Qiita

2020/02/22 19 users CONTEXT Twitter Qiita mattn 時期

背景 Go1.14 で context パッケージが少し改善されるのは mattn さんの twitter を見て知った方も多いのではないでしょうか。このツイートされた時期と同じくらいにちょうど社内の勉強会で context パッケージをみんなで読んでおり、皆完全に context を理解したので ある程度実装も把握していました。勉強会では GoDoc ... 続きを読む

GoDoc を多用している - blog.syfm

2019/04/21 86 users blog.syfm

最近は設計をする際にできる限り API 仕様を正確に記述するようにしている。このことを意識し始めた大きな要因は主に次の 2 つだと思う。 1 つ目は以前、前職で働いているときに柴田さんに API 仕様の重要性を教えてもらったことから。この時に聞いたことは以下のブログ記事にまとまっているのでぜひ読んでほしい。 yshi... 続きを読む

GoのExampleテストが便利 : swdyh

2015/08/19 52 users swdyh Testing 仕組 testingパッケージ

Goでは、Example用のコードをgodocに表示させたり、テストとして実行して結果をチェックをすることができます。Example用のコードを書いて、それをドキュメントにコピペする作業や、その内容が古くなって動かないということから開放してくれます。 この仕組についてはtestingパッケージに説明があります。 testing - The Go Programming Language http:... 続きを読む

Goライブラリを作ったら、とりあえずgomarkdown - None is None is None

2014/10/01 6 users Usage example Functions 規模 内容

2014-10-01 Goライブラリを作ったら、とりあえずgomarkdown Go 小さなGoライブラリをつくった時、ほとんど自分しか使わないような規模なら、わざわざREADMEに「Usage」「Example」「Functions」なんて書くのは面倒ですよね。 そんな時は、gomarkdownで自動生成してしまうのがオススメです。 godocと同等の内容をGithub flavored mar... 続きを読む

Hello GoDoc!

2014/09/08 35 users GAE 来年 福岡 学生 東京

Hello GoDoc! Presentation Transcript Hello GoDoc! GoDocのためのコメントフォーマット Fukuoka.go #2 - 2014/8/21 @laco0416 About Me Suguru INATOMI a.k.a. laco0416 ● 21歳 学生 ● Go歴半年くらい 主にGAE/Go ● 福岡から来ました ● 来年から東京にいます A... 続きを読む