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

Как узнать, что созданный код легко читается, понятен и поддерживается? Конечно, с точки зрения автора, код удобен для чтения и сопровождения, потому что автор написал и отредактировал его, для начала. Однако должен существовать объективный и поддающийся количественному измерению стандарт, по которому наша профессия может измерять код. Эти цели достигаются, когда …

336 code-quality  code-reviews  readability  maintainability 

Мой босс продолжает упоминать беспечно , что плохие программисты используют breakи continueв петлях. Я использую их все время, потому что они имеют смысл; позвольте мне показать вам вдохновение: function verify(object) { if (object->value < 0) return false; if (object->value > object->max_value) return false; if (object->name == "") return false; ... …

192 coding-style  language-agnostic  syntax  readability  control-structures 

Все программисты, похоже, согласны с тем, что читаемость кода гораздо важнее, чем однострочные с коротким синтаксисом, которые работают, но требуют, чтобы старший разработчик интерпретировал их с какой-то степенью точности - но, похоже, именно так были разработаны регулярные выражения. Была ли причина для этого? Мы все согласны с тем, что selfDocumentingMethodName()гораздо …

160 readability  regular-expressions 

Обычно я использую закрытые методы для инкапсуляции функциональности, которая повторно используется в нескольких местах в классе. Но иногда у меня есть большой публичный метод, который можно разбить на более мелкие этапы, каждый из которых имеет свой собственный приватный метод. Это сделало бы открытый метод короче, но я обеспокоен тем, что …

139 coding-style  readability 

Когда я пишу код, я всегда стараюсь сделать мой код максимально чистым и читабельным. Время от времени наступает момент, когда вам нужно пересечь черту и перейти от красивого чистого кода к более уродливому коду, чтобы сделать его быстрее. Когда это нормально, чтобы пересечь эту линию?

67 performance  optimization  quality  readability  maintainability 

Поэтому, оглядываясь назад, я заметил несколько комментариев о том, что длинные методы являются плохой практикой. Я не уверен, что всегда согласен с тем, что длинные методы плохие (и хотел бы узнать мнение других). Например, у меня есть несколько представлений Django, которые выполняют небольшую обработку объектов перед отправкой их в представление, …

64 readability  methods 

Что легче понять: большой логический оператор (довольно сложный) или тот же оператор, разбитый на методы предикатов (много дополнительного кода для чтения)? Вариант 1, большое логическое выражение: private static bool ContextMatchesProp(CurrentSearchContext context, TValToMatch propVal) { return propVal.PropertyId == context.Definition.Id && !repo.ParentId.HasValue || repo.ParentId == propVal.ParentId && ((propVal.SecondaryFilter.HasValue && context.SecondaryFilter.HasValue && propVal.SecondaryFilter.Value …

63 c#  readability 

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

59 c  readability  patterns-and-practices  const 

Мой стиль кодирования для вызовов вложенных функций следующий: var result_h1 = H1(b1); var result_h2 = H2(b2); var result_g1 = G1(result_h1, result_h2); var result_g2 = G2(c1); var a = F(result_g1, result_g2); Недавно я перешел в отдел, где очень популярен следующий стиль кодирования: var a = F(G1(H1(b1), H2(b2)), G2(c1)); Результатом моего способа …

57 c#  c++  coding-style  readability  maintainability 

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

52 php  naming  readability  camelcase 

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

45 coding-style  variables  readability  naming 

Часто, когда синтаксис языка требует, чтобы я назвал переменную, которая никогда не используется, я назову ее _. На мой взгляд, это уменьшает беспорядок и позволяет мне сосредоточиться на значимых переменных в коде. Я нахожу это ненавязчивым, так что он производит эффект «с глаз долой, с ума». Типичным примером того, где …

44 language-agnostic  naming  readability  variables 

Я запутался в функциях min и max в определенных контекстах. В одном контексте, когда вы используете функции для получения большего или меньшего из двух значений, это не проблема. Например, //how many autographed CD's can I give out? int howManyAutographs(int CDs, int Cases, int Pens) { //if no pens, then I …

40 design  functions  readability 

При использовании метода цепочки, как: var car = new Car().OfBrand(Brand.Ford).OfModel(12345).PaintedIn(Color.Silver).Create(); может быть два подхода: Повторно используйте тот же объект, например так: public Car PaintedIn(Color color) { this.Color = color; return this; } Создавайте новый объект типа Carна каждом шаге, например так: public Car PaintedIn(Color color) { var car = new …

37 coding-style  readability  method-chaining 

Стоит ли жертвовать читабельностью кода тем, насколько он эффективен? например, 3 строки кода в 1 строку. Я прочитал в Code Craft Питом Гудлиффом, что читабельность - это ключ. Твои мысли?

37 code-quality  performance  optimization  readability