禁止事項だけでなく推奨事項を伝える

安易に「○○禁止」と言わない。それが禁止ということは分かっても、他にどうするのが良いのかが伝わりづらい。

だから、禁止事項と併せて、推奨事項を伝える。その際、例にする推奨事項はできるだけ実態に即した内容で書く。

・定数に小文字を使うのは禁止。
・定数をキャメルケースで書くのは禁止。
・例:HOGE

これでは、「複数の単語の場合にどう区切ることを推奨されているのか (ハイフンケースか、スネークケースか)」が明記されておらず、認識齟齬が発生する恐れがある。

・定数は小文字を使用せず、大文字で書いてください。
・定数における単語の区切りは、アンダースコア (_) で書いてください。
・例:
 ・CUSTOMER
  ・SERVER_URL