Документ зі стандартами кодування є корисним. Це найбільш корисно , коли це досить коротка , що хто - небудь може згадати все це без особливих проблем , а коли це не викликає нікому занадто багато болю.
Те, як ви вирішили вводити код відступу у вашій організації або використовувати великі літери, застосовувати петлі, або коментувати ваш код не має великого значення; корисна частина - це змусити всіх писати код, який виглядає приблизно так само, як і всі інші.
- Це дозволяє уникнути необхідності витратити хвилину, повторно оцінюючи своє очікування, де мають бути брекети, і таке щоразу, коли ви дивитесь чужого коду.
- Це дозволяє уникнути наявності декількох різних стилів коду в одному файлі.
- Мабуть, найголовніше - наявність письмового стандарту уникає аргументів щодо практики кодування під час огляду коду.
Знову ж таки, те, що стандарти - це не так важливо, як мати якийсь простий, простий стандарт. Отже, помістіть усіх розробників у кімнату і нехай вони сперечаються щодо того, якими мають бути стандарти. Ця зустріч може тривати нескінченно, тому правила такі:
- Все, що не буде вирішено до кінця наради, вирішить керівник.
- Зустріч закінчиться через дві години, або коли хтось почне кричати чи плакати, залежно від того, що станеться раніше.
- Весь стандарт поміститься (у розумному розмірі!) На аркуші паперу або двох, двосторонній, лише якщо це абсолютно необхідно.
Подумайте про прийняття когось | чужі | стандарти або як відправна точка для власної зустрічі зі стандартами кодування, або як спосіб уникнути зустрічі повністю.
Після досягнення домовленості розробники повинні мати можливість (і слід очікувати) поліції самих. Іноді відхилення від стандарту не повинно бути великою справою (і це може бути навіть виправдано), але зухвало відмова відмовитись від якогось улюбленого особистого стилю на користь стандарту має призвести до негайного переїзду до офісу за допомогою протікаючих водопровідних труб чи будь-чого іншого .
Дем'ян Брехт вказує на інструменти для ворсу. Вони є ідеальним доповненням до документа стандартів кодування. Це просто добре дотримуватися стандартів стилю кодування ; це важливо дотримуватися стандартів кодування , які відносяться до небезпечної практики. Ніхто, окрім автора, не збирається перевіряти, чи відповідає кожен рядок коду стандарту для стилю, але ви, безумовно, повинні розглянути можливість створення інструменту для втручання в робочий процес вашої команди для автоматичного пошуку можливих помилок. Крім того, сам інструмент може кодифікувати прийняті практики, так що вам не доведеться перераховувати їх окремо у стандартах кодування; просто вкажіть конфігурацію інструмента.
Примітка. Ідея "стандартів кодування" не характерна лише для програмування. "Стандарти кодування" застосовуються у багатьох сферах, іноді в межах організації, частіше у всій галузі чи професії. Деякі приклади:
У кожному конкретному випадку (та багато інших) компетентний практик може легко зрозуміти "код", який не відповідає очікуваному стандарту. Чому так багато галузей наполягають на написанні детальних вимог до документів, які навіть не потрібно розбирати компілятором? Тому що стиль має значення . Представлення інформації у стандартному стилі дозволяє читачеві повністю зосередитись на вмісті, робить читання швидшим та сприяє розумінню та зменшує помилки.