Чому функція повинна мати лише одну точку виходу? [зачинено]

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

Я думав, що це має щось спільне з CS, але це питання було збито на cceheory stackexchange.

Існують різні школи мислення, і це здебільшого зводиться до особистих переваг.

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

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

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

Я прямо в середньому таборі. Застосування однієї точки виходу є безглуздим або навіть контрпродуктивним обмеженням IMHO, тоді як випадковий вихід по всьому методу іноді може призвести до безладної важкої для дотримання логіки, де стає важко зрозуміти, буде чи не буде заданий біт коду. страчений. Але "встановлення" вашого методу дозволяє значно спростити суть методу.

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

  if (! аргумент) // Перевірте, чи не є null
    повернути ERR_NULL_ARGUMENT;
  ... обробляти ненульовий аргумент
  якщо (добре)
    повернути 0;
  ще
    повернути ERR_NOT_OK;

чіткіше ніж:

  int return_value;
  if (аргумент) // Не нульовий
  {
    .. обробляти ненульовий аргумент
    .. встановити результат належним чином
  }
  ще
    результат = ERR_NULL_ARGUMENT;
  повернутий результат;

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

Точка входу та виходу була оригінальною концепцією структурованого програмування проти покрокового кодування спагетті. Існує думка, що для кількох функцій точки виходу потрібно більше коду, оскільки вам потрібно правильно очистити місця в пам'яті, виділені для змінних. Розглянемо сценарій, коли функція розподіляє змінні (ресурси), і вихід з функції рано та без належного очищення призведе до витоків ресурсів. Крім того, побудова очищення перед кожним виходом створить багато зайвого коду.

У більшості випадків це зводиться до потреб результату. У "старі часи" код спагетті з кількома точками повернення запрошував витік пам'яті, оскільки кодери, які віддавали перевагу цьому методу, як правило, погано очищалися. Також виникали проблеми з тим, що деякі компілятори «втрачали» посилання на змінну return, оскільки стек з’являвся під час повернення, у випадку повернення з вкладеної області. Більш загальною проблемою була проблема з повторним входом коду, який намагається, щоб стан виклику функції був точно таким же, як і стан повернення. Мутатори oop порушили це, і концепція була відкладена.

Існують результати, зокрема ядра, яким потрібна швидкість, яку забезпечують кілька точок виходу. Ці середовища зазвичай мають власну пам’ять і управління процесами, тому ризик витоку зводиться до мінімуму.

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

- 2 центи

Детальніше див. Цей документ: NISTIR 5459

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

1. Можливо, код з одним виходом легше читати та налагоджувати. (Я визнаю, що я не надто думаю з цієї причини, але вона подана. Що значно легше читати та налагоджувати, це код одного входу .)
2. Код з одним виходом посилається і повертається більш чисто.

Друга причина є тонкою і має певні переваги, особливо якщо функція повертає велику структуру даних. Однак я б надто не хвилювався про це, хіба що ...

Якщо ви студент, ви хочете отримати найкращі оцінки у своєму класі. Робіть те, що віддає перевагу викладач. Ймовірно, у нього є вагома причина з його точки зору; отже, принаймні, ви дізнаєтесь його перспективу. Це має цінність саме по собі.

Удачі.

Раніше я був прихильником стилю єдиного виходу. Мої міркування здебільшого спричинені болем ...

Одиночний вихід легше налагодити.

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

Це особливо актуально, коли вам потрібно було вставляти завдання, щоб перевірити стан (замінено виразами годинника в сучасних налагоджувачах). Також було занадто легко змінити потік управління таким чином, щоб приховати проблему або взагалі порушити виконання.

Методи одиночного виходу легше було пройти через налагоджувач і легше роздратувати, не порушуючи логіки.

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

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

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

Якщо ви відчуваєте, що вам потрібні кілька точок виходу у функції, функція занадто велика і робить занадто багато.

Я б порекомендував прочитати розділ про функції книги Роберта К. Мартіна "Чистий код".

По суті, вам слід спробувати писати функції з 4 рядками коду або менше.

Деякі примітки з блогу Майка Лонга :

• Перше правило функцій: вони повинні бути малими
• Друге правило функцій: вони повинні бути меншими за це
• Блоки в операторах if, в той час як оператори, для циклів тощо, повинні складати один рядок
• ... і цей рядок коду, як правило, буде викликом функції
• Має бути не більше одного або, може, двох рівнів відступу
• Функції повинні робити одне
• Оператори функцій повинні бути на одному рівні абстракції
• Функція повинна мати не більше 3 аргументів
• Вихідні аргументи - це запах коду
• Передати логічний прапор у функцію - це справді жахливо. Ви за визначенням робите дві функції у функції.
• Побічні ефекти - це брехня.