error messageに絶対書くべきこと
背景
- 世の中にあるエラーメッセージの程度が低くなっている気がする。元から低い？
- コードはシンプルに綺麗に！というのが曲解されてエラーメッセージもシンプルにされた？
- 「失敗しました。◯◯である必要があります」というエラーメッセージにすごくイライラしている。で、どうすれば良いんだよ、、が多い。
という問題に何度か遭遇して考えて自分の結論を出したので残しておく
（あとググってもそういう記事があまりなかった。error messageのhow toはあるけど、should beがない！）
答え
「どこ」で、 where
「あなたのどの入力が」、 what
「何のルールに抵触して失敗した」、 why
「だからどうする」 how to
（順番はもう少し考える必要があるかも。）
サンプル
-
「権限が不足しています」
-> リソース設定の変更に失敗しました。あなたの権限「user」の権限では、リソース「xx」の設定を変更することができません。設定のためには「admin」権限を持つユーザが行うか、xxの箇所からあなたの権限を設定してください。 -
「ユーザ名が不正です」
-> ユーザ名の入力に失敗しました。入力された記号「ω」は、ユーザ名には許可されていません。ユーザ名は英数字及び「-」のみで入力してください。 -
「DB connect failed.」
->DB connect failed. Can't open socket. Connection was over-flow. Properly closed socket?
後書き
- もっといいやり方知っている人は教えてください