はじめに
本記事は以下のツイートの翻訳転載です。
エラーメッセージを大文字で始めたり区切り記号で終えたりしない
これは、最初は少し変に見えるかもしれないですが、実用的な理由があります。
なぜ小文字で始めるのでしょうか?
エラーメッセージは他のメッセージと組み合わされることがあります。
もしエラー文字列が大文字で始まっていると、それが文の途中に挟まれたときに不自然に見えたり、場違いに見えたりします。
エラーメッセージを小文字で始めると、組み合わされたメッセージに、そのメッセージをより自然になじませることができます。
// application startup failed: failed to initialize module: could not open the database
もう一つのポイントは、メッセージの最後に"... "が現れることです。
これは、フォーマットされたエラー文字列の%w
に続くテキストは、メッセージ全体の最後に追加されることを意図していることを意味します。
なぜ区切り記号で終えないのでしょうか?
それは、あるメッセージが別のメッセージに追加されたとき、
その結果がフレーズのごちゃまぜではなく、首尾一貫した文のように見えるようにするためです。
おわりに
go1.20でerrors.Join
が追加されている。
この関数でエラーを結合すると、:
ではなく、 \n
で結合されたメッセージとなる。
こうなると大文字始まり/区切り文字終わりのエラーメッセージを結合した際の不自然さが軽減されるのではないかと思っている。
つまり大文字始まりや区切り文字終わりについては気にしなくてもよくなったのかもしれない。