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

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

142 coding-standards  comments  standards  naming-standards  standardization 

Я бачив цю частину PEP-8 https://www.python.org/dev/peps/pep-0008/#package-and-module-names Мені не ясно, чи стосується це ім'я файлу модуля / класу / пакета. Якби у мене був один приклад з кожного, чи мають усі імена файлів у нижньому регістрі з підкресленнями, якщо це доречно? Або щось інше?

137 python  coding-style  naming-standards 

Глава дядька Боба про імена в Чистому кодексі рекомендує уникати кодування імен, головним чином щодо угорських позначень. Він також конкретно згадує про видалення Iпрефікса з інтерфейсів, але не показує прикладів цього. Припустимо наступне: Використання інтерфейсу полягає в основному для досягнення простежуваності шляхом введення залежності У багатьох випадках це призводить до …

68 c#  naming  clean-code  naming-standards 

Виходячи з переважно c # фону, я звик використовувати термін "інтерфейс" для опису об'єкта без реалізації, який визначає поведінку. У c # умовою є додавання назв інтерфейсу з "Я", як у IEnumerable, тощо. Звичайно, концепція має різні назви різними мовами. У Свіфта те саме поняття називається "протокол". Коли я розробляю …

53 naming-standards  swift-language 

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

51 naming  naming-standards 

Якщо є метод bool DoStuff() { try { // doing stuff... return true; } catch (SomeSpecificException ex) { return false; } } чи варто його швидше називати IsStuffDone()? Обидва імені може бути неправильно інтерпретовано користувачем: Якщо ім'я, DoStuff()чому воно повертає булеве? Якщо назва - IsStuffDone()невідомо, чи метод виконує завдання чи …

33 naming  methods  naming-standards  parameters  return-type 

Я щойно відправив проект у Github, вніс зміни та ін. Це мене здивувало: я бачу в основному README.txt у проектах з відкритими джерелами, а файл, який я редагував, був Readme.txt. Це якась стандартизація чи я мав би залишити її так, як є?

33 naming-standards 

Якщо програмне забезпечення / бібліотека має деяку підтримку платформи Windows, вони майже завжди називають свої каталоги та змінні як win32. Це найбільше поширення в проектах C / C ++. Навіть цільове потрійне використання проекту MinGWwin32 . Чи є для цього причина? Чому б не використовувати власне ім’я, як Windows або …

31 coding-standards  naming-standards 

Я нещодавно працюю з об’єктом XMLHttpRequest в JavaScript, і я не міг не помітити, що обробка цього імені не має сенсу. Чому "XML" є у всіх заголовках, а "Http" - ні? Вони обоє абревіатури! Звичайно, було б більше сенсу, щоб ім'я було одним із таких: XmlHttpRequest (PascalCase, найкраща практика для …

28 javascript  naming  xmlhttprequest  naming-standards 

Це досить усталене умовлення, що назви таблиць бази даних, принаймні, у SQL, повинні бути єдиними. SELECT * FROM user;Дивіться це питання та обговорення . Також досить усталеною умовою є те, що імена ресурсів RESTful API повинні бути множинними. GET /users/123і POST /usersдивіться цей . У найпростішому API, що підтримує базу …

27 rest  api  sql  conventions  naming-standards 

Це питання було перенесено із переповнення стека, оскільки на нього можна відповісти на Exchange Software Stack Exchange. Мігрували 8 років тому . Я тільки починаю вивчати C #. Виходячи з фону в Java, C ++ та Objective-C, я вважаю, що C # у Pascal-casing його методах називає досить унікальними, і …

22 c#  programming-languages  history  naming-standards 

Java SE 8 поставляється з новим механізмом дат, введення LocalDate, LocalTimeі LocalDateTimeкласів для подання моментів часу. Для управління такими миттєвостями, набір методів Дано: LocalDate.plusDays(...), LocalDate.minusDays(...)і так далі. Я завжди вважав, що хороша практика - називати методи після дієслів, що описують їх призначення, оскільки методи - це фактично операції, які потрібно …

21 java  methods  naming-standards 

Прочитавши відповідь gnat на " Чому статичний основний метод у Java та C #, а не конструктор? Я вважаю, що його відповідь означає, що мета класу Java зі статичним основним методом полягає в define a program entry pointтому, що це не сама програма. Можливо, є кращий спосіб зробити це, але …

21 java  naming  naming-standards  entry-point 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 4 роки тому . Якщо ви використовуєте змінні, у яких множина та однина є однаковими, як їх називати? …

20 c#  naming  naming-standards  language-discussion 

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

20 c#  .net  naming  class-design  naming-standards