Нека да разберем какво представляват коментарите и защо са важни в програмирането.
Ние също така обхващаме два често срещани типа коментари и как да ги напишете на 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 често срещани типа – единичен и многоредов. Също така се опитах да обясня защо коментарите са полезни и човек трябва да ги пише, когато е необходимо. Надявам се да сте научили нещо ново!
Продължавайте да изследвате. Продължавай да учиш! 👨💻