Правила хорошего тона программирования

Список некоторых правил хорошего тона программирования, которые применимы преимущественно для Си-подобных языков программирования.

  1. Называть идентификаторы (прежде всего переменные и функции) по типу неправильно. Т. е. нельзя называть переменную типа int именем «number», т.к. это и так по типу понятно, что там хранится число. Переменным надо давать семантические названия, которые будут говорить о чём идёт речь. Напр., «money», «score», «age» и т. д.
  2. В сахарных языках (Java, C#) для каждого метода важно указывать модификаторы доступа, хоть языки к этому строго и не обязывают. Это имеет смысл. Как минимум, будет видно, где методы класса, а где локальные; можно будет поиском пролистать все методы класса с определённым модификатором доступа, и пр.
  3. Булево выражение в условном операторе не сравнивать со значением, т.е. писать просто if (!flg) вместо if (flg != true).
  4. Не писать комментарии, а вместо этого называть идентификаторы понятными именами.

Как можно заметить, многие стандарты, напр., про комментарии и булев тип в условном операторе, исходят из банальной быстроты написания. В итоге, возможно, чуть уменьшается понятность, но увеличивается лаконичность и снижается время написания.