Правила написання коду на java
Такі правила прийняті в нашій компанії. Вони дозволяють робити код більш Новомосковскемим і акуратним, уникати помилок, пов'язаних з різними стилями написання коду у людей, що працюють над проектом, і в майбутньому легко редагувати його.
Імена файлів, пакетів
- В іменах пакетів використовуються тільки малі літери.
- Імена Java-класів даються згідно зі стандартною нотації Java.
- Імена класів повинні бути іменниками, перші літери всіх слів - прописні.
- В іменах web-папок і файлів використовуються тільки малі літери. Слова в багатослівних назвах поділяються підкресленням.
Імена методів, змінних
- Назви методів повинні бути дієсловами, перша буква повинна бути малої, перші літери внутрішніх слів - заголовні.
- Імена змінних повинні починатися з малої літери, внутрішні слова - з великої.
- Імена констант складаються з усіх великих літер, розділених на слова символом підкреслення.
Відступи, довжина рядка, переноси рядків
- Відступи повинні складати строго 4 пробілу (це не знак табуляції).
- Довжина рядка не повинна перевищувати 80 символів.
- Якщо довжина вираження перевищує довжину рядка, то необхідно розбити його на кілька рядків згідно з такими правилами:
- перенос після коми;
- перенос перед оператором;
- необхідно використовувати відступ 8 прогалин для позначення другого рядка розділеного виразу. Наступні рядки вирівнюються по другому рядку або додаються нові 8 прогалин для позначення вкладеності.
Розташування блоків, операторів, прогалини, дужки
структурування коду
- Методи повинні бути короткими, і виконувати тільки одну задачу (наприклад, майже будь-який цикл вже гідний того, щоб винести його в особливий метод).
- Імена методів повинні бути самодокументірованнимі.
- Шаблони ООП повинні застосовуватися для структурування і полегшення сприйняття.