Вопросы с тегом «naming-standards»

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

142 coding-standards  comments  standards  naming-standards  standardization 

Я видел эту часть PEP-8 https://www.python.org/dev/peps/pep-0008/#package-and-module-names Мне не ясно, относится ли это к имени файла модуля / класса / пакета. Если бы у меня был один пример каждого, должны ли имена файлов быть строчными и подчеркивания, если это уместно? Или что-то другое?

139 python  coding-style  naming-standards 

В главе «Дядя Боб» об именах в « Чистом коде» рекомендуется избегать кодировок в именах, главным образом в отношении венгерских обозначений. Он также особо упоминает удаление Iпрефикса из интерфейсов, но не показывает примеров этого. Давайте предположим следующее: Использование интерфейса в основном для достижения тестируемости через внедрение зависимостей Во многих случаях …

68 c#  naming  clean-code  naming-standards 

Исходя из в основном фона c #, я привык использовать термин «интерфейс» для описания объекта без реализации, определяющей поведение. В c # соглашение заключается в добавлении имен интерфейсов с помощью «I», например IEnumerable, и т. Д. Конечно, у концепции разные названия на разных языках. В Swift та же концепция называется …

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;Смотрите этот вопрос и обсуждение . Это также довольно устоявшееся соглашение о том, что имена ресурсов API RESTful должны быть множественными. GET /users/123и POST /usersувидеть это . В простейшем API, …

27 rest  api  sql  conventions  naming-standards 

Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 8 лет назад . Я только начинаю изучать C #. Исходя из опыта работы с Java, C ++ и Objective-C, я нахожу Pascal в C # с именами методов довольно уникальными, …

22 c#  programming-languages  history  naming-standards 

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

21 java  methods  naming-standards 

После прочтения ответа комара на Почему статический основной метод в 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