Конфліктні стилі Java в команді

Я є членом команди з розробки Java зі строком на 6 тижнів. Це вимагає написання великої кількості коду дуже швидко. Однак наша команда розробників має різні стилі кодування. У нашому колективі все - від умовних назв до методів абстракції. Хтось знає якісь документи, які диктують "стандарти" для Java?

Для уточнення, мені було цікаво, чи існує організація, яка б диктувала правильну конвенцію іменування змінних та функцій, наприклад. Це найважливіше, оскільки за такий короткий термін ми не можемо дозволити собі витратити час, намагаючись зрозуміти код інших.

Є така організація: сам Sun / Oracle. Документ називається кодовою конвенцією для мови програмування Java , і він описує більшість необхідних конвенцій. Просто всі погодиться прочитати його та дотримуватися його рекомендацій.

Я дійсно розміщую відповідь Андреса і зосереджуюсь на аспекті, рівномірному форматуванні коду Java.

Якщо ви використовуєте Eclipse, ви можете встановити його формат Java для автоматичного форматування на стандарт Java. Форматор Eclipse також має інші корисні налаштування, такі як символи на рядок (тобто, скільки символів на рядок до переходу на новий рядок) та багато інших. Стандартизація символів в кожному рядку робить його легше дифф коду , написаного різними розробниками , не маючи багато відмінностей тільки від відстані і розриви рядків.

Нарешті, із програмою Eclipse, після встановлення всіх потрібних параметрів, експортуйте свій форматер у файл, який може імпортувати кожен член команди. Тож якщо ви використовуєте Eclipse, я настійно рекомендую повністю вивчити всі параметри, які він буде автоматично форматувати та редагувати код, а потім ділитися налаштуваннями з усією командою.

Я би припустив, що інші основні Java IDE (IntelliJ та Netbeans) мають подібну функцію для експорту параметрів формату.

Це [різні стилі кодування] є першорядним, тому що за такий короткий термін ми не можемо дозволити собі витратити час, намагаючись зрозуміти код інших.

Насправді. Це не найважливіше.

Після 30 років роботи в якості консультанта я прочитав багато кодів у багатьох клієнтів. Важливо зазначити, що у кожного замовника (а часто і в організації замовника) існують різні стилі.

Прочитавши стільки стилів, я це навчився.

Стиль не має значення

Будь ласка, зосередьтеся на написанні коду, який завжди працює, і на тесті одиниць, які підтверджують, що він завжди працює.

Після доставки робочого коду ви можете його одягнути, якщо у вас не виправлено помилок та вдосконалення для встановлення.

Не турбуйтеся про вибір ідеального універсального стандарту. Все, що вам потрібно, це ваша команда погодитися на один стандарт і дотримуватися його. Складіть своє, якщо хочете, але будьте послідовні.

Послідовність покращує співпрацю, співпраця покращує код.

Навіть якщо фактична послідовність не допомагає, той факт, що ваша команда працював разом, щоб досягти згоди, є хорошою справою. Їх нездатність погодитися на щось настільки просто, як конвенції про кодування говорить про те, що можуть виникати більші проблеми в командній роботі, що ховаються під поверхнею.

Згаданий вище Sun CC CC не тільки 13 років, і деякі його правила є застарілими (наприклад, 80 символів на рядок), але також він не визначає умов іменування, за винятком найбільш загальних (корпус верблюда для класів, великі літери) для статичних кінцевих змінних тощо).

Вам потрібно визначити власні стандарти для різних типів класів, наприклад DAO, EJB, сутності, якими б ви не користувалися. Sun Java CC - це як абстрактний базовий клас, призначений для розширення :)

Як згадують інші тут, ви можете шукати в Інтернеті 1 з небагатьох популярних «посібників зі стилів» для Java та переконувати всіх у команді дотримуватися їх. Деякі засоби перевірки коду у вашому улюбленому IDE можуть допомогти вам нагадати, коли ви цього не робите.

Однак іноді бере участь політика. Я колись опинився в ситуації, коли найстарший розробник в команді продовжує робити це так, навіть коли хтось згадав про необхідність стандартизації. У такій ситуації, можливо, краще буде дотримуватися його стилю коду та дотримуватися його, оскільки він, мабуть, володіє найвищими знаннями про кодову базу та вимоги, і ви, можливо, не хочете витрачати час наступаючи на пальці ніг, навіть якщо йому важко. Що саме ми робили в цій конкретній ситуації, і я неохоче слідкую за цим.

Тому важливо врахувати і вашу ситуацію.

Дядько Боб демонструє більш сучасний та сучасний стиль кодування у своїй книзі «Чистий код». На жаль, він не містить списку елементів. Ви повинні його прочитати. Сам він каже, що щоб побачити його умовності, ти повинен прочитати його код. Дядько Боб, без сумніву, є своєрідним закладом. Книга в будь-якому випадку є чудовим читанням, тому навіть якщо зараз її вже пізно читати, читайте її якнайшвидше.

Що дійсно має значення в коді - це низька цикломатична складність, малий обсяг, висока згуртованість та вибір експресивних ідентифікаторів. З огляду на це, код стає зрозумілим легко, і такий код хороший.

Я пропоную вивчити спартанське програмування .

Більшість стандартів кодування розповідає, як зробити так, щоб погано написаний код виглядав досить красиво, і більшість дискусій про "стиль кодування" насправді стосується форматування. Форматування коду - це візуально представляти структуру вашого коду. Це тривіально і автоматично, і ледве нічого не робити зі стилем кодування, тому що стиль кодування - це не про те, як ви представляєте структуру коду, а про те, як ви структуруєте код.
Існує також багато релігійних воєн з приводу іменування конвенцій, хоча насправді вони просто хакінг для подолання поганого дизайну. Ім'я добре, якщо воно говорить, що воно означає. Чим менше і чіткіше ваші сфери застосування, тим простіше вибрати таку назву.