2008-06-25 (Wed)

_ Error message style guide

PostgreSQLでのドキュメントに、開発者向けの「エラーメッセージのスタイルガイド」なるものがあった。内容がえらく具体的で参考になる。たとえば、時制について:

試行が失敗したが、次は(何らかの問題を修正した後に)成功するかもし
れない場合は過去形を使用してください。失敗が永続するようであれば、
現在形を使用してください。

以下の2つの意味には無視できないほどの違いがあります。
 could not open file "%s": %m
および 
 cannot open file "%s"
最初のものは、ファイルを開くことに失敗したことを意味します。メッ
セージには、"ディスクが一杯"や"ファイルが存在しない"といった、その
理由を付けるべきです。次回はディスクに空きがあるかもしれませんし、
問題のファイルが存在するかもしれませんので過去形が適切です。

2番目の形式は、そのプログラム内の指名されたファイルを開く機能が存
在しない、あるいは、概念的に不可能であることを示します。この条件は
永遠に続きますので現在形が適切です。 
本日のツッコミ(全1件) [ツッコミを入れる]
_ gerriecollins (2008-07-01 (Tue) 23:33)

gOoYe1

[]