Яким стандартам слідувати

Переклад статті Стівена Дж. Бігелоу "What coding standards in software engineering should we follow?"

Поняття стандартів кодування у програмній інженерії дещо суб'єктивне. На практиці організації приймають та застосовують стандарти кодування для досягнення низки бізнес-цілей. Угоди та посібники з кодування різняться залежно від галузі, організації, команди і, можливо, навіть між проектами.

У більшості ситуацій програмісти використовують стандарти кодування в розробці програмного забезпечення, намагаючись покращити чотири різні атрибути додатка: зручність обслуговування, надійність, ефективність та зручність використання.

Стандарти обслуговування

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

Стандарти надійності

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

Стандарти ефективності

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

Стандарти юзабіліті

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