Давайте дізнаємось, що таке коментарі та чому вони важливі в програмуванні.
Ми також розглядаємо два поширені типи коментарів і те, як їх писати 15 різними мовами програмування.
Що таке коментарі в програмуванні?
Коментарі з точки зору неспеціаліста – це фрагменти тексту, які не будуть видимі для кінцевих користувачів і призначені для довідки людей, які пишуть код.
Трохи більш формально, коментар – це опис програми про те, як вона працює, у простому читабельному форматі. Зазвичай вони використовуються в тих місцях, де необхідно надати деяку додаткову ясність розробнику, який читає код. Таким чином, це допомагає покращити читабельність коду та зменшує час і спілкування, які потрібні для передачі знань.
Компілятор/інтерпретатор просто ігнорує коментарі у вашому коді, таким чином не впливаючи на кінцевий результат вашої програми. Отже, у двох словах, коментарі — це просте пояснення певних фрагментів коду, яке можна читати.
Поширені типи коментарів
Більшість мов програмування підтримують 2 типи коментарів.
- Однорядковий коментар
- Багаторядковий коментар / блок коментарів
Як випливає з назви, однорядкові коментарі корисні, коли потрібно додати маленький однорядковий текст, наприклад. певний стан, постійне значення, яке потребує невеликого опису. У той час як багаторядковий працює краще, коли ми маємо більший обсяг інформації, яку потрібно додати, як-от опис функції та способів її використання тощо.
Існують інші типи коментарів, як-от коментарі документів, але вони виходять за рамки цієї статті.
Чому варто додавати коментарі?
«Будь-який дурень може написати код, який зрозуміє комп’ютер. Хороші програмісти пишуть код, зрозумілий людям». – Мартін Фаулер
Головною перевагою додавання коментарів є покращена читабельність і краще розуміння програми. Окрім цього, деякі інші переваги включають:
- Через коментарі вашим колегам і навіть іншим розробникам надзвичайно легко зрозуміти логіку, не читаючи довгу документацію.
- Зменшення спілкування між розробниками через невеликі сумніви
- Коментарі ігноруються компілятором/інтерпретаторами.
- Для програмного забезпечення з відкритим кодом вони є обов’язковими, оскільки ви не пояснюєте кожну функцію мільйонам розробників, які хочуть використовувати цю конкретну програму.
Коментарі кількома мовами
Чудово, тепер ми дізналися про коментарі та чому вони корисні. Давайте дослідимо, як ми можемо додавати коментарі різними мовами програмування.
Однорядковий коментар
// This is a single line comment in C/C++
Багаторядковий коментар
/* This is slightly long multi line comment in C/C++ */
Однорядковий коментар
# This is a single line comment in Python
Багаторядковий коментар
# This is slightly long # multi line comment in Python
Однорядковий коментар
// This is a single line comment in Java
Багаторядковий коментар
/* This is slightly long multi line comment in Java */
Однорядковий коментар
# This is a single line comment in Ruby
Багаторядковий коментар
=begin This is slightly long multi line comment in Ruby =end
Однорядковий коментар
// This is a single line comment in Golang
Багаторядковий коментар
/* This is slightly long multi line comment in Golang */
Однорядковий коментар
– – This is a single line comment in Haskell
Багаторядковий коментар
{- This is slightly long
multi line comment in Haskell -}
Однорядковий коментар
// This is a single line comment in Rust
Багаторядковий коментар
/* This is slightly long multi line comment in Rust */
Однорядковий коментар
<!-- This is a single line comment in HTML -->
Багаторядковий коментар
<!-- This is slightly long multi line comment in HTML -->
Однорядковий коментар
/* This is a single line comment in CSS */
Багаторядковий коментар
/* This is slightly long multi line comment in CSS */
Однорядковий коментар
// This is a single line comment in Javascript
Багаторядковий коментар
/* This is slightly long multi line comment in Javascript */
Однорядковий коментар
# This is a single line comment in R programming language
Багаторядковий коментар
R не підтримує багаторядкові коментарі.
Однорядковий коментар
% This is a single line comment in Erlang
Багаторядковий коментар
R не підтримує багаторядкові коментарі.
Однорядковий коментар
// This is a single line comment in PHP
Багаторядковий коментар
/* This is slightly long multi line comment in PHP */
Однорядковий коментар
# This is a single line comment in Perl
Багаторядковий коментар
=begin This is slightly long multi line comment in Perl =end
Однорядковий коментар
// This is a single line comment in Kotlin
Багаторядковий коментар
/* This is slightly long multi line comment in Kotlin */
Висновок
Підручник охоплював основи коментарів і 2 поширених типи – однорядковий і багаторядковий. Я також спробував пояснити, чому коментарі корисні і їх потрібно писати, коли це необхідно. Сподіваюся, ви дізналися щось нове!
Продовжуйте досліджувати. Продовжуйте вчитися! 👨💻