エラーメッセージの変数命名どうするか ~msg vs eMsg vs errorMsg~

背景

表題3つが乱立していたため、リファクタリングをするにあたりどれが良いか検討することになった。

結論

errorMsg一択！
→msgやeMsgではエラーメッセージなのかを判別しにくいため。
　命名はなんでも短くしたり省略したりすればいいわけではない。
　可読性の観点も踏まえて、第3者が読む労力を減らす取り組みが必要。

例1：msg

msgだけでは、該当コードの前後を読まなければどのようなメッセージなのか判断することが難しい。

const msg = "情報を取得できません。";

例2：eMsg

eMsgでも同様。
eでerrorを表現できている気がしなくもないが、それならerrorと記載する方が可読性の観点から良いと判断。

const eMsg = "情報を取得できません。";

例3：errorMsg

errorMsgとすることで、エラーメッセージであることを瞬時に判別可能。
文字数が一番長いが、それ以上に可読性が高いと判断。

const errorMsg = "情報を取得できません。";

おわりに

とはいえ、省略せず長い命名ではコード量が多くなり、かえって可読性が悪くなる。
この辺のバランス感覚を意識していくことを心がけていきたい。