Nézzük meg, mik azok a megjegyzések, és miért fontosak a programozásban.
A megjegyzések két gyakori típusával és 15 különböző programozási nyelven történő megírásával is foglalkozunk.
Tartalomjegyzék
Mik a megjegyzések a programozásban?
A laikus kifejezésekkel írt megjegyzések olyan szövegrészek, amelyek nem lesznek láthatók a végfelhasználók számára, és a kódot író személyek számára hivatkozási célt szolgálnak.
Kicsit formálisabban a megjegyzés egy program leírása, amely leírja annak működését, egyszerűen olvasható formátumban. Ezeket általában olyan helyeken használják, ahol a kódot átolvasó fejlesztő számára további egyértelműséget kell biztosítani. Így ez segít a kód olvashatóságának javításában, és csökkenti a tudás átadásához szükséges időt és kommunikációt.
A fordító/tolmács egyszerűen figyelmen kívül hagyja a kódban lévő megjegyzéseket, így nincs hatással a program végkimenetére. Tehát dióhéjban a megjegyzések olyanok, mint egy egyszerű, olvasható magyarázat bizonyos kódrészletekre.
A megjegyzések gyakori típusai
A legtöbb programozási nyelv kétféle megjegyzést támogat.
- Egysoros megjegyzés
- Többsoros megjegyzés / megjegyzés blokkolása
Ahogy a neve is sugallja, az egysoros megjegyzések akkor hasznosak, ha kis egysoros szöveget kell hozzáadni, pl. egy adott feltétel, egy állandó érték, amelyhez kis leírásra van szükség. Míg a többsoros jobban működik, ha nagyobb mennyiségű információt kell hozzáadnunk, például leírást egy függvényről és annak használatáról stb.
Vannak más típusú megjegyzések is, például a dokumentumhoz fűzött megjegyzések, de ezek nem tartoznak a cikk hatókörébe.
Miért érdemes megjegyzéseket fűzni?
„Minden bolond tud olyan kódot írni, amit egy számítógép is megért. A jó programozók olyan kódot írnak, amelyet az emberek megértenek.” – Martin Fowler
A megjegyzések hozzáadásának fő előnye a jobb olvashatóság és a program jobb megértése. Ezen túlmenően, néhány további előny:
- A megjegyzések segítségével társai és még más fejlesztők is rendkívül könnyen megérthetik a logikát anélkül, hogy hosszú dokumentációkat olvasnának át.
- Csökkentett kommunikáció a fejlesztők között az apró kétségek miatt
- A megjegyzéseket a fordító/tolmácsok figyelmen kívül hagyják.
- Nyílt forráskódú szoftvereknél ezek elengedhetetlenek, mivel nem lesz ott, hogy minden funkciót elmagyarázzon több millió fejlesztőnek, akik használni szeretnék az adott programot.
Megjegyzések több nyelven
Nagyszerű, most, hogy megismertük a megjegyzéseket és azt, hogy miért hasznosak. Vizsgáljuk meg, hogyan adhatunk hozzá megjegyzéseket különböző programozási nyelveken.
Egysoros megjegyzés
// This is a single line comment in C/C++
Többsoros megjegyzés
/* This is slightly long multi line comment in C/C++ */
Egysoros megjegyzés
# This is a single line comment in Python
Többsoros megjegyzés
# This is slightly long # multi line comment in Python
Egysoros megjegyzés
// This is a single line comment in Java
Többsoros megjegyzés
/* This is slightly long multi line comment in Java */
Egysoros megjegyzés
# This is a single line comment in Ruby
Többsoros megjegyzés
=begin This is slightly long multi line comment in Ruby =end
Egysoros megjegyzés
// This is a single line comment in Golang
Többsoros megjegyzés
/* This is slightly long multi line comment in Golang */
Egysoros megjegyzés
– – This is a single line comment in Haskell
Többsoros megjegyzés
{- This is slightly long
multi line comment in Haskell -}
Egysoros megjegyzés
// This is a single line comment in Rust
Többsoros megjegyzés
/* This is slightly long multi line comment in Rust */
Egysoros megjegyzés
<!-- This is a single line comment in HTML -->
Többsoros megjegyzés
<!-- This is slightly long multi line comment in HTML -->
Egysoros megjegyzés
/* This is a single line comment in CSS */
Többsoros megjegyzés
/* This is slightly long multi line comment in CSS */
Egysoros megjegyzés
// This is a single line comment in Javascript
Többsoros megjegyzés
/* This is slightly long multi line comment in Javascript */
Egysoros megjegyzés
# This is a single line comment in R programming language
Többsoros megjegyzés
R nem támogatja a többsoros megjegyzéseket.
Egysoros megjegyzés
% This is a single line comment in Erlang
Többsoros megjegyzés
R nem támogatja a többsoros megjegyzéseket.
Egysoros megjegyzés
// This is a single line comment in PHP
Többsoros megjegyzés
/* This is slightly long multi line comment in PHP */
Egysoros megjegyzés
# This is a single line comment in Perl
Többsoros megjegyzés
=begin This is slightly long multi line comment in Perl =end
Egysoros megjegyzés
// This is a single line comment in Kotlin
Többsoros megjegyzés
/* This is slightly long multi line comment in Kotlin */
Következtetés
Az oktatóanyag a megjegyzések alapjait és két gyakori típusát – egysoros és többsoros – ismertette. Megpróbáltam kitérni arra is, hogy miért hasznosak a megjegyzések, és miért kell megírni őket, amikor szükséges. Remélem tanultál valami újat!
Folytassa a felfedezést. Tanulj tovább! 👨💻