More than 3 years have passed since last update.

疎通確認が目的のタスク名には ping を入れるとわかりやすい

Posted at 2020-11-30

こんにちは、株式会社ベストティーチャーで元気に働くたわらです。業務駆け出しエンジニアです。

業務に駆け出すと、いろんな学びがあります。今回はpingです。

先輩　「hogeサーバーから毎日何らかのデータを取ってくるrakeタスクを作ってほしい」
先輩　「諸事情で、通信すること自体が目的なんだ」
ボク　「ハイ！」

何とか実装して、タスク名をrequest_to_hogeとしてプルリクを出すと、、、

先輩　「、、、何をリクエストしてるかわかりずらいですね、、、」
先輩　「後から参画するエンジニアにもわかりやすい名前にしよう」
先輩　「こういうときは ping を変数に入れるといいよ」

対象のコンピューターときちんとつながっているかどうか、を確認するときに使用するコマンドのことです。

例えば、Raspberry PiにUbuntuを入れて、ネットワークを設定して、ホストマシン（Mac）側からssh接続するための前準備として、まず通信接続を確認するときなどに当該IPアドレスを指定して、pingコマンドを利用します。

この作業を疎通確認、と言います。

なので、変数にpingを入れると疎通確認を目的としたタスクだ、ということが示せます。

先輩　「ということで、ping_hoge という名前にしよう」
先輩　「これなら後から参画したエンジニアもタスクの意味が把握しやすいからね」
ボク　「ハイ！」

後から参画する方にわかりやすい名前をつける、という気づきがありました。
変数がわかりにくいとコールドリーディングにコストがかかってしまいます。
この瞬間だけではなくて、長い時間のなかでわかりやすい変数の名前をつけるのが大事なのですね。

pingとは｜「分かりそう」で「分からない」でも「分かった」気になれるIT用語辞典
https://wa3.i-3-i.info/word124.html