Як використовувати ярлик коментарів у VS Code

У кодуванні коментарі є одним із небагатьох способів зберегти думки на майбутнє. Вони можуть допомогти вам розібратися у фрагментах коду та можуть бути корисними для наступного розробника, який намагатиметься зрозуміти, що ви написали кілька днів тому. Якщо ви використовуєте Visual Studio Code (VS Code), немає потреби щоразу невтомно вводити розділювачі коментарів. VS Code має вбудовану функцію швидкого доступу, яка економить секунди (і навіть хвилини) вашого часу.

Ярлик для коментарів Quick VS Code

Для тих, хто поспішає, ось ваш золотий квиток:

• Для однорядкового коментаря використовуйте комбінацію клавіш Ctrl + / у Windows або Linux або Cmd + / на Mac.
  ,
• Для блокового коментаря використовуйте Shift + Alt + A у Windows або Linux або Shift + Option + A на Mac.
  ,
• Щоб закоментувати код, ви можете натиснути Ctrl + K + C на Windows або Cmd + K + U на Mac.
  ,

Більшість кодерів багато коментують. І йдеться не лише про те, щоб залишати справжні коментарі, але, можливо, важливіше те, що ви коментуватимете та розкоментуєте код. Це життєздатне для тестування, експериментів і налагодження.

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

Коментування поза основами

Хоча основні комбінації клавіш — це справжній подарунок, для коментування VS Code є набагато більше. Давайте заглибимося глибше:

Переключити коментарі

Найкраща частина ярликів для коментарів VS Code – це їх функція перемикання. Вам не потрібно возитися та видаляти кожен маркер коментаря вручну, якщо ви передумали (або під час налагодження). Замість цього ви просто використовуєте ті самі ярлики. За допомогою тих самих комбінацій клавіш ви можете швидко перемикатися між коментованим і некоментованим кодом, щоб залишатися організованим, коли вам це найбільше потрібно.

Коментування кількох рядків

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

Вкладені коментарі

Іноді вставлення коментарів у блок коду може призвести до неочікуваних результатів і помилок, якщо роздільники не збігаються дуже добре. Тут вам може допомогти Intellisense Visual Studio Code. Він налаштує для вас форматування коментарів навіть у межах уже закоментованого блоку, тому не буде конфліктів із вкладеними коментарями.

Розширення коментування Supercharge

VS Code — це редактор із відкритим вихідним кодом, який служить платформою для розробників, щоб викласти свої найкращі розширення. Ринок переповнений розширеннями, які надають вам більше можливостей і користі під час коментування:

Кращі коментарі

Коментування може здатися невеликою та необов’язковою частиною кодування, але існує так багато творчих способів використання коментарів. Розширення Better Comments допомагає додати цілеспрямованості та ясності коментарям, які ви розсипаєте, класифікуючи їх за сповіщеннями, запитами, TODO та іншими категоріями. І це все з додатковим бонусом кольорового кодування для покращеної видимості та організації. Ваші коментарі стають орієнтирами та роздільниками, які роблять ваш код акуратнішим і доступнішим.

Якір коментарів

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

Полакод

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

Навіщо коментувати?

Коментування – це не просто прапорець, який потрібно поставити галочкою, чи необов’язкова робота, яку виконують багатослівні люди; це невід'ємна частина кодування. Ось деякі з причин цього:

Ясність

Кодери прагнуть зробити нерозв’язне зрозумілим. Написання коду, який працює, іноді може бути більш простим, ніж написання коду, який легко зрозуміти та слідувати. Коментарі — це компас розробника — безцінна допомога в навігації просторами коду, незалежно від того, чи вони легкі й молоді, чи щільні й зрілі. Можливо, ви маєте справу із заплутаними алгоритмами чи таємничими бізнес-процесами. У будь-якому випадку, коментарі забезпечують знайому руку в морі складності.

Співпраця

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

Налагодження

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

Поради щодо ефективного коментування

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

Будьте лаконічними

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

Уникайте очевидних коментарів

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

Використовуйте коментарі для «Чому», а не «Що»

Ваш код викладає факти того, що відбувається. Але коментарі можуть розповісти глибшу історію. Вони передають мотивацію та процеси мислення, які стоять за вашими рішеннями. Чому ви вибрали цей алгоритм замість іншого? Про які підводні камені слід пам’ятати? Можливо, ви спробували якийсь код, який багато хто рекомендував би, але він не спрацював або був неефективним. Ви можете передати набагато більше, ніж прості інструкції з добре продуманими коментарями.

Залишити коментар

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

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