Запитання з тегом «naming»

Раніше були дуже вагомі причини, щоб імена інструкцій / реєстрів були короткими. Ці причини більше не застосовуються, але короткі криптовалютні імена все ще дуже поширені в програмуванні низького рівня. Чому це? Це просто тому, що старі звички важко порушити, чи є кращі причини? Наприклад: Atmel ATMEGA32U2 (2010?): TIFR1(Замість TimerCounter1InterruptFlag), ICR1H(замість …

64 naming  coding-standards  low-level 

Мені завжди важко обирати форми однини та множини для назв класів: CustomerRepository vs. CustomersRepository CustomerService vs. CustomersService CustomerController vs. CustomersController А для складених імен це ще складніше: OrderCustomerRepository vs. OrderCustomersRepository vs. OrdersCustomersRepository Який підхід ви віддаєте перевагу і чому?

58 naming  source-code 

Яка краща назва методу, який повертає булевий? IsSupportContentType або CanSupportContentType

51 naming  naming-standards 

Здається, що консенсус полягає в тому, що слід дотримуватися конвенції платформи, для якої вони розробляються. Побачити: Підкреслення чи верблюд? Названня конвенцій: camelCase проти underscore_case? Однак, схоже, PHP не суворо дотримується будь-якої конвенції внутрішньо (сюрпризів немає), навіть щодо методів та функцій (наприклад mysqli::set_local_infile_default, PDOStatement::debugDumpParams); однак підкреслення, здається, є домінуючим у назвах …

51 php  naming  readability  camelcase 

Чи слід завжди використовувати isв якості префікса булеві змінні? А що з булевими, які щось вказують на минуле? Треба писати isInitializedчи wasInitialized? Чи слід писати для властивостей IsManyMembersабо HasManyMembers? Чи є найкращі практики? Або я просто повинен писати відповідно до англійських правил?

50 coding-style  naming  boolean 

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

48 naming  variables 

У мене завжди виникають проблеми з з'ясуванням, чи варто називати певний метод, починаючи з getSomethingпорівняння findSomething. Проблема полягає у створенні помічників для погано розроблених API. Зазвичай це відбувається при отриманні даних від об'єкта, який вимагає об'єкт як параметр. Ось простий приклад: public String getRevision(Item item) { service.load(item, "revision"); // there …

48 naming  methods 

Я часто бачу код, який включає навмисні написання загальних слів, які на краще чи гірше стали зарезервованими словами: klassабо clazzдля класу :Class clazz = ThisClass.class kountдля підрахунку в SQL:count(*) AS kount Особисто я вважаю, що це зменшує читабельність. У власній практиці я не знайшов занадто багато випадків, коли кращого імені …

45 coding-style  variables  readability  naming 

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

44 language-agnostic  naming  readability  variables 

Чи є гарною практикою викликати змінну, яку метод повертає зі змінною назвою result? Наприклад: public Zorglub calculate() { Zorglub result = [...] [...] return result; } Або я повинен назвати його за його типом? public Zorglub calculate() { Zorglub zorglub = [...] [...] return zorglub; } Я бачив і те, …

44 programming-practices  naming  variables 

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

43 naming  functions 

Я не впевнений, що робити з наступним: Ми беремо дані із зовнішнього інструмента в межах власного інструменту. Ці дані написані голландською мовою. Ми пишемо наш код Java англійською мовою. Чи повинні ми тоді перекласти цю голландську на англійську чи зберегти її голландською? Наприклад, у нас є 2 відділи: Bouw (будівництво …

39 naming  translate 

Я потягнув звідси термін smurf іменування (номер 21). Щоб врятувати будь-кого, хто не знайомий з проблемою, іменування Smurf - це акт префіксації купи пов’язаних класів, змінних тощо із загальним префіксом, щоб у результаті ви отримали " SmurfAccountViewпропуск a SmurfAccountDTOдо SmurfAccountController" тощо. Я зазвичай чув це рішення - створити простір імен …

39 naming  coding-standards 

Чи достатньо, щоб методи розрізняли лише за назвою аргументу (а не типом) чи краще називати його більш чітко? Так , наприклад T Find<T>(int id)проти T FindById<T>(int id). Чи є якась вагома причина назвати це більш чітко (тобто додавати ById) проти збереження лише імені аргументу? Я можу подумати, коли підписи методів …

36 c#  naming  coding-standards  conventions  method-overloading 

Є деякі імена, де, якщо ви виявите, що дотягуєтесь до цих імен, ви знаєте, що вже щось зіпсували. Наприклад: XxxManager Це погано, оскільки клас повинен описувати, що робить клас. Якщо найбільш конкретне слово, яке ви можете придумати для того, що робить клас, - це "керувати", то клас занадто великий. Які …

35 naming  anti-patterns