Повідомлення про єдину лінію та належні практики

Нещодавно я придбав звичку, за якою я знаю, що багато хто з вас може нахмуритися, але, врешті-решт, допомагає мені стежити за структурою глобального коду, а не за структурою єдиного (іноді) повторюваного методу: групування числа виписок в одному рядку, як це:

textBox1.Text = "Something!"; textBox2.Text = "Another thing!"; textBox3.Text = "Yet another thing!";

на відміну від

textBox1.Text = "Something!";
textBox2.Text = "Another thing!";
textBox3.Text = "Yet another thing!";

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

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

Також подумайте, як ви читаєте код. Це завжди зверху вниз, прокручування вниз. Ваш метод не поєднується з цим і навіть вводить одне з найпотворніших можливих проблем при читанні коду; прокручування по горизонталі . Ніколи не варто недооцінювати, наскільки важко це може зробити читання коду. Ви ніколи не прокручуєте горизонтально, ніколи не змушуєте людей прокручуватися горизонтально, майже в будь-якому контексті це вкрай неприродно.

Крім того, якщо ваша проблема повторюється введенням коду ... не забувайте Ctrl-C. З вашого прикладу коду може бути ефективніше вводити все вручну, але якщо вам доведеться скопіювати купу рядків в кілька разів, здається, що було б так само ефективно скопіювати рядок один плюс новий рядок, вставити його x разів і вносити зміни, менша ймовірність зробити друк також.

О, і друкарські помилки! Пошкодження читабельності вашого коду може призвести до того, що кошмар зможе знайти, яку з 50 змінних оголошень ви встановили неправильно. Більшість компіляторів зараз помиляються у номерах рядків І стовпців, але знайти помилку в рядці МНОГО простіше, ніж знайти стовпець.

Одне твердження за рядком також полегшує бачити, що змінилося в бічній стороні розбіжності.

Хоча приклад цього не показує, є ще одна проблема з групуванням кількох висловлювань в одному рядку. Що робити, якщо одне із п’яти висловлювань у одному рядку кидає виняток?

Ваш слід стека буде говорити "EBlah у рядку N" ... і тепер ви не знаєте, яке з цих п'яти тверджень викинуло виняток.

(Те ж саме відбувається з надмірно довгим твердженням будь-якого виду.)

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

З цієї причини я раджу проти цього, за винятком рідкісних обставин.

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

Я зараз перемагаю при думці про це (хоча це було зроблено з уважної причини).

На жаль, такий код важко читати, а значить, важко підтримувати.

Синтаксично в цьому насправді немає нічого поганого. Це дійсно залежить від стилю кодування вашої команди.

Оскільки більша частина коду, який я бачив (включаючи код, який знаходиться у стандартних заголовках c ++) робиться таким чином, я б пішов із вашим першим методом.

textBox1.Text = "Something!";
textBox2.Text = "Another thing!";
textBox3.Text = "Yet another thing!";

Це дійсно незвичний стиль кодування.

Я б рекомендував вам використовувати порожні рядки для розмежування логічних частин коду.

Занадто далеко вправо може створити стільки ж проблем, скільки кількох ліній.

Мені довелося зіткнутися з деякими заявами sql з десятками полів. Як правило, я ставлю по одному на рядок, але за декількох випадків я об'єднав 3 або 4 до ряду. Це здається гарною ідеєю під час розробки, коли вам доведеться кілька разів прокручувати вгору та вниз.

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

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

Поклавши руки на голову на хвилину, він використовуватиме його улюблені функції IDE Regex, щоб автоматично розділити весь цей нечитабельний код на один вислів на рядок.

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

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

Подивіться на свій приклад: ви відразу знаєте, що код - це Textвластивість різних textBoxоб'єктів, і вони містять рядок як значення. Досить прямо.

Я б особисто не користувався таким стилем. Узагальнити

Плюси

• менше рядків коду для прокрутки
• може бути використаний для семантично групування коду для вираження: "багато матеріалів про призначення". АЛЕ Ви завжди можете переробляти такий блок на функцію, якщо він занадто сильно Вас турбує.

Мінуси

• важко читати, як правило, простіше читати код по горизонталі (скуммінг, відсутність руху очей, ...)
• diff легко стає кошмаром, включаючи злиття
• складніше змінити (копіювати та вставляти, коментувати, ...)
• налагодження може бути проблемою для багатьох IDE, оскільки вони працюють на лініях замість окремих виразів.