Скільки параметрів занадто багато? [зачинено]

Рутини можуть мати параметри, це не новина. Ви можете визначити стільки параметрів, скільки вам може знадобитися, але занадто багато їх буде ускладнювати розуміння та підтримку розпорядок дня.

Звичайно, ви можете використовувати структуровану змінну як спосіб вирішення: розміщення всіх цих змінних в одній структурі та передача їх у порядок. Насправді, використання структур для спрощення списків параметрів - один із методів, описаних Стівом МакКоннеллом у Code Complete . Але як він каже:

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

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

Моє запитання, коли я можу вважати список параметрів занадто великим? Я думаю, що понад 5 параметрів, занадто багато. Що ти думаєш?

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

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

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

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

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

HWND CreateWindowEx
(
  DWORD dwExStyle,
  LPCTSTR lpClassName,
  LPCTSTR lpWindowName,
  DWORD dwStyle,
  int x,
  int y,
  int nWidth,
  int nHeight,
  HWND hWndParent,
  HMENU hMenu,
  HINSTANCE hInstance,
  LPVOID lpParam
);

Це 12 параметрів (9, якщо ви поєднаєте x, y, w і h у вигляді прямокутника), а також є параметри, похідні від назви класу. Як би ви зменшили це? Чи хотіли б ви зменшити кількість до кращого?

Не дозволяйте, щоб кількість параметрів вас турбувало, просто переконайтесь, що це логічно і добре зафіксовано, і нехай intellisense ^* допоможе вам.

^* Доступні інші помічники кодування!

У « Чистому кодексі» Роберт К. Мартін присвятив цій темі чотири сторінки. Ось суть:

Ідеальна кількість аргументів для функції дорівнює нулю (niladic). Далі йде одна (монадійна), а за нею близько - двоє (діадична). По можливості слід уникати трьох аргументів (тріадичних). Більше трьох (поліадичних) вимагає дуже спеціального обґрунтування - і тоді їх не слід використовувати.

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

Будь ласка, не робіть цього!

(Зазвичай.)

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

Дуже дякую за всі ваші відповіді:

• Було трохи дивно, коли я знайшов людей, які також думають (як і я), що 5 параметрів є хорошим обмеженням для надійності коду.

• Як правило, люди сходяться на думці, що межа між 3 і 4 - це добре правило. Це розумно, оскільки люди зазвичай погано перераховують більше 4 речей.

• У Мілані точок , в середньому людина може тримати більш-менш 7 речей в їх голові в той час. Але я думаю, що ви не можете забути, що, розробляючи / підтримуючи / вивчаючи рутину, потрібно пам’ятати більше про речі, а не лише про параметри.

• Деякі люди вважають, що рутина повинна мати стільки аргументів, скільки потрібно. Я погоджуюся, але лише для кількох конкретних випадків (дзвінки в API API, підпрограми, де важлива оптимізація тощо). Я пропоную приховати складність цих процедур, додавши шар абстракції трохи вище цих дзвінків, коли це можливо.

• Нік має цікаві думки з цього приводу. Якщо ви не хочете читати його коментарі, підсумовую: у двох словах, це залежить :

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

  Мораль тут не бійтеся показувати свій код одноліткам, обговоріть з ними і намагайтеся "визначити сфери, де у вас низька згуртованість і тісний зв'язок" .

• Нарешті, я думаю, що Wnoise дуже погоджується з Ніком, і завершує свій сатиричний внесок цим поетичним баченням (див. Коментарі нижче) мистецтва програмування:

  Програмування - це не інженерія. Організація коду - це мистецтво, оскільки воно залежить від людських факторів, які занадто сильно залежать від контексту для будь-якого жорсткого правила.

Ця відповідь передбачає мову ОО. Якщо ви не використовуєте - пропустіть цю відповідь (це не зовсім мовно-агностична відповідь іншими словами.

Якщо ви передаєте більше 3-х параметрів (особливо внутрішніх типів / об'єктів), це не так, що це "Занадто багато", але, можливо, вам не вистачає шансу створити новий об'єкт.

Шукайте групи параметрів, які переходять у більш ніж один метод - навіть група, що передається двома методами, майже гарантує, що у вас має бути новий об’єкт.

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

Схоже, є й інші міркування, ніж просто число, ось деякі, які приходять на думку:

1. логічне відношення до основного призначення функції проти одноразових налаштувань

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

Одна з відомих програмових епіграм Алана Перліса (переказана в повідомленнях ACM SIGPLAN 17 (9), вересень 1982 р.) Говорить, що "Якщо у вас є процедура з 10 параметрами, ви, ймовірно, деякі пропустили".

За словами Стіва МакКоннела в " Кодексі повним" , ви повинні

Обмежте кількість параметрів програми приблизно на сім

Для мене, коли список перетинає один рядок у моєму IDE, то це один параметр занадто багато. Я хочу бачити всі параметри в одному рядку, не порушуючи контакт очей. Але це лише мої особисті переваги.

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

Сім речей у короткотерміновій пам'яті?

1. Назва функції
2. Повернене значення функції
3. Призначення функції
4. Параметр 1
5. Параметр 2
6. Параметр 3
7. Параметр 4

У найгірших 5 фрагментах коду перевірте другий: "Це конструктор". Він має приблизно 37 ⋅ 4 ≈ 150 параметрів:

Ось програміст написав цей конструктор [... S] Оме з вас може подумати, що це великий конструктор, але він використовував автоматичні інструменти генерації коду затемнення [.] NOO, у цьому конструкторі була крихітна помилка, яку я виявив, яка зробила мене зробіть висновок, що цей конструктор був написаний від руки. (до речі, це лише верхня частина конструктора, її не закінчена).

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

void *
mmap(void *addr, size_t len, int prot, int flags, int fildes, off_t offset);

Є 6 аргументів, і кожен з них є важливим. Крім того, між ними немає спільного зв’язку, який би виправдовував їх об'єднання. Можливо, ви могли б визначити "struct mmapargs", але це було б гірше.

Згідно з найкращими практиками Perl , 3 добре, 4 - це занадто багато. Це просто настанова, але в нашому магазині саме цього ми намагаємося дотримуватися.

Я сам намалював би обмеження для публічних функцій на 5 параметрів.

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

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

97 звучить приблизно так.

Все менше, і ви втрачаєте гнучкість.

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

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

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

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

На мою думку, можуть бути випадки, коли ви перевищуватимете 4 чи якусь фіксовану кількість. Що можна оглянути

1. Ваш метод робить занадто багато, і вам потрібно зробити рефактор.
2. Ви можете розглянути можливість використання колекції або якоїсь структури даних.
3. Перегляньте дизайн свого класу, можливо, деякі речі не потрібно переносити навколо.

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

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

Для мене це дорівнює приблизно 5, але я не такий яскравий. Ваш пробіг може відрізнятися.

Ви можете створити об'єкт із властивостями для утримування параметрів та передачі цього, якщо ви перевищуєте встановлений вами межа. Дивіться книгу " Рефакторинг" Мартіна Фаулера та розділ щодо спрощення викликів методів.

Це сильно залежить від середовища, в якому ви працюєте. Візьмемо для прикладу javascript. У javascript найкращим способом передачі параметрів є використання об'єктів з парами ключ / значення, що на практиці означає, що у вас є лише один параметр. В інших системах солодке місце буде в три-чотири.

Зрештою, все зводиться до особистого смаку.

Я погоджуся з 3 добре, 4 - це занадто багато, як настанова. Маючи більше 3 параметрів, ви неминуче виконуєте більше одного завдання. Більше одного завдання слід розділити на окремі методи.

Однак, якби я подивився на останній проект, над яким працював, винятків було б багато, і більшість випадків було б важко спуститися до 3 параметрів.

Якщо у мене є 7-10 параметрів в одній рутині, я дивлюся на об'єднання їх у новий клас, але не, якщо цей клас був би не що інше, як купа полів з getters та setters - новий клас повинен робити щось інше, ніж переміщення значень у та з. В іншому випадку я б швидше помирився зі списком довгих параметрів.

Відомий факт, що в середньому люди можуть одночасно тримати 7 +/- 2 речі в голові. Мені подобається використовувати цей принцип із параметрами. Якщо припустити, що програмісти - це все розумні люди середнього рівня середнього рівня, я б сказав, що всього 10+ - це занадто багато.

BTW, якщо параметри будь-яким чином схожі, я ставлю їх у вектор або список, а не в структуру чи клас.

Я б базував свою відповідь на тому, як часто викликається функція.

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

Якщо це називається купа разів на кадр, то я схильний робити структуру і просто передавати вказівник на неї, оскільки це, як правило, швидше (якщо вважати, що ви не перебудовуєте структуру також кожен раз).

За словами Джеффа Безоса з Амазонської слави, не можна більше годувати двома піцами :