0
0

More than 1 year has passed since last update.

Google Open Source(Go)ではDeprecated(非推奨)なコードがわかりやすく表示される

Last updated at Posted at 2022-11-19

netパッケージのソースコードを読んでいると、ファイル内で使われているsyscallパッケージの記述に打ち消し線が引かれていた

スクリーンショット 2022-11-19 15.26.42.png

他にも、この画像でいうとCancelにも打ち消し線が引かれている。
まあ、なんとなくどういうときに打ち消し線が引かれるのか予想はできるが、軽く調べてみた。


どういうときに打ち消し線が引かれるかというと、そのパッケージやメソッド、型や変数がdeprecated(非推奨)のとき。

Goでは、Deprecated:という修飾を含んだコメントを記述することで、対象が非推奨であることを伝えることができる1。もちろん、この記述は開発者による目視のときのサポートだけではない。静的解析ツールのstaticcheckには、この記述がある関数や型などを呼び出していると警告してくれる機能がある2

この規則を利用して、Go本体、標準・準標準パッケージのソースコードが管理されているGoogle Open Source内では、そういった非推奨になっているコードの記述が一瞬で分かる様になっているという仕組み。便利。

GitHubで管理されているソースコードは、こういったことは上記で説明したようなLintを実行してみないとわかりにくい。GitHubにもこういった痒い所に手が届く機能があると良いな。

  1. https://github.com/golang/go/wiki/Deprecated

  2. https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0