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

Раньше были очень веские причины для краткости названий инструкций / регистров. Эти причины больше не применяются, но короткие загадочные имена все еще очень распространены в низкоуровневом программировании. Почему это? Это просто потому, что старые привычки трудно сломать, или есть более веские причины? Например: Atmel ATMEGA32U2 (2010?): TIFR1(Вместо TimerCounter1InterruptFlag), ICR1H(вместо InputCapture1High), …

64 naming  coding-standards  low-level 

Мне всегда сложно выбирать между формами имен в единственном и множественном числе: CustomerRepository vs. CustomersRepository CustomerService vs. CustomersService CustomerController vs. CustomersController А для составных имен это еще сложнее: OrderCustomerRepository vs. OrderCustomersRepository vs. OrdersCustomersRepository Какой подход вы предпочитаете и почему?

58 naming  source-code 

Похоже, консенсус заключается в том, что нужно следовать соглашению платформы, для которой они разрабатывают. Видеть: Подчеркивание или верблюд? Соглашения об именах: camelCase или underscore_case? Тем не менее, PHP, кажется, строго не следует никаким внутренним соглашениям (никаких сюрпризов) даже для методов и функций (например mysqli::set_local_infile_default, PDOStatement::debugDumpParams); однако подчеркивания, кажется, доминируют в …

52 php  naming  readability  camelcase 

Какое имя лучше для метода, который возвращает логическое значение? IsSupportContentType или же CanSupportContentType

51 naming  naming-standards 

Должен ли я всегда использовать в 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 

Должны ли булевы методы всегда принимать утвердительную форму, даже если они будут использоваться только в отрицательной форме? Скажем, я хотел проверить, существует ли сущность, прежде чем создавать ее, я утверждаю, что первая форма ниже лучше второй формы, независимо от того, используется ли метод когда-либо в утвердительной форме. В итоге, мне …

44 naming  functions 

Я не уверен, что делать со следующим: Мы берем данные из внешнего инструмента в нашем собственном инструменте. Эти данные написаны на голландском языке. Мы пишем наш Java-код на английском языке. Должны ли мы затем перевести этот голландский на английский или оставить его на голландском? Например, у нас есть 2 отдела: …

39 naming  translate 

Я вытащил отсюда термин «смурф» (номер 21). Чтобы избавить кого-то, кто не знаком с проблемой, именование Smurf - это префикс префикса группы связанных классов, переменных и т. Д. С общим префиксом, так что в итоге вы получаете «a SmurfAccountViewpass a SmurfAccountDTOto 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