Как упростить чтение кода для себя?
Как упростить чтение кода для других разработчиков?
Почему важно повышать читаемость кода?
Hа понимание того, что делает код, тратится меньше времени.
Как достичь высокой читаемости кода?
Использовать стандартные соглашения по написанию кода.
Internal Convention/Style of a specific company/project
Использовать какой-то Naming Convention.
Naming Convention - это ТОЛЬКО соглашение.
Naming Convention не несет принудительные правила.
Naming Convention несет рекомендуемые правила.
Для именования использовать:
lower_snake_case
уникальные имена в рамках одного package
обратное domain name как prefix для packages
_
для исключительных случаев
java.util
javax.xml
com.rakovets.code_convention
com.rakovets._do
com.rakovets._2d_array
hyphenated-name.example.org → org.example.hyphenated_name
example.int → _int.example
123name.example.com → com.example._123name
Для именования использовать:
UpperCamelCase
существительные
String
ArrayList
StringRegexUtil
Для именования использовать:
UpperCamelCase
прилагательные (иногда существительные)
Runnable
Comparable
Serializeable
Remote
ActionListener
Для именования использовать:
lowerCamelCase
глаголы (чаще всего)
имя отражающее то, что он делает или возвращает
getName()
addElement()
size()
calculate()
Для именования использовать:
lowerCamelCase
существительные
имя отражающее смысл хранимого значения
i
- index
k
- key
firstname
currentTitle
Для именования использовать:
UPPER_SNAKE_CASE
final
static final double PI = 3.141592653
final int MAX_AGE = 150
Для именования использовать:
UPPERLETTER
E
- Element
T
- Type
K
- Key
V
- Value
etc. - for other types