読者です 読者をやめる 読者になる 読者になる

隙あらば寝る

うぇぶのかいしゃではたらくえんじにあがかいています

golangでDeprecated APIのドキュメント

Deprecating things in Go · go bits

で紹介されている Deprecated な API のドキュメントについて。

新しいAPIの追加等に伴って、古いAPIを非推奨扱いにしてドキュメントを書くことがある。

その場合、ドキュメント(godoc)を書く場合に// Deprecated: でコメントを始めるのがこれからの作法になりそうという話。

まだ対応途中のようだが、このルールに従ってコメントを書くと

godoc において表示が変わったり、golintにおいてレポートが出たりするようになるような検討が行われているらしい。

ライブラリ提供をするのであればこの機能は欲しくなるので覚えておきたい。