Запитання з тегом «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; ... } Суть у тому, що …

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

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

160 readability  regular-expressions 

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

139 coding-style  readability 

Коли я пишу код, я завжди намагаюся зробити свій код максимально чистим і читабельним. Раз у раз настає час, коли вам потрібно перейти лінію та перейти від приємного чистого коду до трохи потворнішого коду, щоб зробити це швидше. Коли це нормально, щоб перетнути цю лінію?

67 performance  optimization  quality  readability  maintainability 

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

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ключового слова. Я розумію, що він використовується для реалізації поведінки лише для читання на змінних. Мене бентежить, які існують різні ситуації, коли це може бути корисним. Чи слід його використовувати для наочності в прототипах функцій? Чи слід його використовувати як захід …

58 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); однак підкреслення, здається, є домінуючим у назвах …

51 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 cannot sign …

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 Car(this); …

37 coding-style  readability  method-chaining 

Чи варто жертвувати читабельністю коду тим, наскільки ефективний код? наприклад, 3 рядки коду в 1 рядок. Я читав у Code Craft Піта Гудліффа, що читабельність є ключовою. Ваші думки?

37 code-quality  performance  optimization  readability