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

142
Стандарт кодирования для ясности: прокомментировать каждую строку кода?

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

139
Соглашение об именах файлов Python?

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

68
Проблемы с именами: следует ли переименовать «ISomething» в «Something»? [закрыто]

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

53
Соглашения о присвоении имен протоколу Swift [закрыто]

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

33
Readme.txt против README.txt

Я только что разработал проект в Github, внес свои изменения и т. Д. Это заставило меня задуматься: в основном я вижу README.txt в проектах с открытым исходным кодом, а файл, который я редактировал, был Readme.txt. Это своего рода стандартизация или я должен был оставить все как...

33
Как назвать метод, который одновременно выполняет задачу и возвращает логическое значение в качестве состояния?

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

31
Почему программное обеспечение использует имя Win32?

Если у программного обеспечения / библиотеки есть некоторая поддержка для платформы Windows, они почти всегда называют свои каталоги и переменные как win32. Это наиболее распространено в проектах C / C ++. Даже целевое тройное использование проекта MinGWwin32 . Есть причина для этого? Почему бы не...

28
Почему XMLHttpRequest не соответствует соглашению об именах?

Я недавно работал с объектом XMLHttpRequest в JavaScript, и я не мог не заметить, что использование этого имени не имеет смысла. Почему «XML» в заглавных буквах, а «Http» - нет? Они оба аббревиатуры! Конечно, было бы более разумно, чтобы имя было одним из следующих: XmlHttpRequest (PascalCase,...

27
Почему в соглашении говорится, что имена таблиц БД должны быть единичными, а ресурсы RESTful - множественными?

Это довольно устоявшееся соглашение, что имена таблиц базы данных, по крайней мере в SQL, должны быть единичными. SELECT * FROM user;Смотрите этот вопрос и обсуждение . Это также довольно устоявшееся соглашение о том, что имена ресурсов API RESTful должны быть множественными. GET /users/123и POST...

22
Какова философия / обоснование имен методов Cascal-Casing?

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

21
Соглашения об именах для классов Java, которые имеют статический метод main?

После прочтения ответа комара на Почему статический основной метод в Java и C #, а не конструктор? Я полагаю, что его ответ означает, что цель Java-класса со статическим основным методом заключается в define a program entry pointтом, что он не предназначен для самой программы. Возможно, есть лучший...

21
Являются ли «плюс» и «минус» подходящими именами методов?

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

20
Какова история именования констант в верхнем регистре?

Какова история условного обозначения констант в верхнем регистре? Моя интуиция заключается в том, что это началось с препроцессора C, где люди разработали практику именования макросов препроцессора в верхнем регистре, чтобы они эффективно жили в отдельном пространстве имен и избегали конфликтов...

20
Каковы стандарты работы с множественным числом слов в вашем коде? [закрыто]

Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Когда вы используете переменные, у которых их множественное и единственное...

20
Какова идея именования классов с суффиксом «Info», например: «SomeClass» и «SomeClassInfo»?

Я работаю в проекте, который имеет дело с физическими устройствами, и меня смутило, как правильно назвать некоторые классы в этом проекте. Учитывая фактические устройства (датчики и приемники) - это одно, а их представление в программном обеспечении - другое, я думаю о присвоении имен некоторым...

20
В чем причина использования строчных букв для первого слова в локальной переменной (например, employeeCount, firstName)

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

19
C # - Почему префиксы на полях не рекомендуется?

В старые времена мы делали венгерские записи. Теперь это считается пассивным , и по большей части я его больше не использую, но я все еще нахожу использование m_префикса для обозначения полей-членов. Для меня, если я читаю чужой код и вижу это: count = 3; Я предполагаю, что countэто локальная...

15
Как лучше всего присваивать имена загруженным изображениям?

Предположим, у меня есть форма в моем веб-приложении, где пользователи могут загрузить изображение профиля. У меня мало требований к размеру файла, размерам и т. Д., Но когда пользователь загружает изображение, как мне их назвать в моей системе? Я предполагаю, что это должно быть последовательным и...

15
Стандарты именования среды в разработке программного обеспечения?

Мой проект в настоящее время страдает от проблем именования среды. У разных людей разные предположения относительно того, какие среды следует называть или какие имена обозначают, и это вызывает путаницу при их обсуждении. Я провел небольшое исследование и не нашел там никаких стандартов. Термины...