Коментарите се използват за добавяне на информация към кода. Най-често се игнорира от компилатора, но човешките специалисти могат да прочетат тези коментари, когато видят вашия код. Коментарите са от съществено значение за разработчиците, защото имат ограничено време и коментирането им позволява да получат ценна информация наведнъж или да отбележат някои важни подробности по отношение на кода. Достъпът до тези данни им позволява да вземат правилните решения и да работят по-бързо.
Как коментарът може да бъде полезен за мен?
Коментарите са полезни за вас лично и за всеки, който може да се наложи да прочете или редактира този код по-късно. Но как точно?
- Коментарите могат да бъдат заместители при кодиране. В този момент може да предположите нещо и ще знаете дали предположението ви е вярно в бъдеще.
- Коментарите могат да документират мислите ви или да бъдат бележки за вас самите, така че да не забравите постъпките си, когато се върнете към тях по-късно.
- Можете да включите коментари за това, което сте направили във вашия код, за да могат други програмисти да го разберат по-добре и по-бързо (времето на кодери е много, много скъпо).
- Можете да използвате коментари, за да деактивирате временно или да активирате бъгове части.
- Коментирането на всеки ред от скрипта улеснява проследяването къде може да има грешки в програмата.
- Коментарите могат да обяснят какво правят определени редове от кода или защо сте избрали някакъв конкретен подход, за да избегнете недоразумения (например, когато някои части от кода са предназначени за определен раздел или конкретната цел, която трябва да разберете ясно) ,
- Можете да напишете цял параграф, обясняващ всички подробности за секцията с код, ако е необходимо за начинаещи или хора от други проекти. Коментирането често е необходимо при писане на сложни SQL заявки с много клаузи като INNER JOIN, GROUP BYs и др.
- Коментирането ви позволява да правите бележки за това, което правите. Това помага на другите да разберат как и защо сте направили нещо, за да могат да го поддържат или променят според нуждите.
SQL добър език за коментари ли е?
Да! Коментарите най-често се използват във връзка с езици като SQL и PHP, където можем да ги вмъкнем в текстов файл или скрипт с помощта на функцията за коментар * / (например /* Това е моят коментар */). Те обикновено са също толкова лесни за използване навсякъде другаде.
Как да коментирам в SQL?
Функцията за коментар ще ви позволи да напишете произволен текст, за да добавите коментар в SQL. Това не засяга крайния изход, стига да идва преди или след определен предварително програмиран символ.
За да добавите коментари в SQL, можете да използвате следните символи:/* */ или # или — (двойно тире).
/* */ ще работи за всяка ситуация, в която искате да започнете и да завършите коментара си в този момент, без да използвате нищо друго (като единични кавички).
# се използва за един ред код в даден момент
— важи и за един ред код наведнъж. Не забравяйте да поставите интервал след това двойно тире.
Във вашия код ще изглежда по следния начин:
-- this is a comment# this is also a comment/*
multiline
comment
*/
Ето разликата между едноредовите и многоредовите коментари:
mysql> SELECT 1+1; # This comment continues to the end of line
mysql> SELECT 1+1; -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;
Ето още един пример за многоредов коментар:
SELECT contact_id, last_name, first_name
/*
* Author: TechOnTheNet.com
* Purpose: To show a comment that spans multiple lines in your SQL
* statement in MySQL.
*/
FROM contacts;
Коментиране с помощта на символа #
Основният хеш коментар стил може да се вмъкне в текст по следния начин:
Select * from users ; # this will list usersКоментиране с помощта на двойното тире (–)
Това е горе-долу същото (не забравяйте пространството). Стандартният SQL всъщност не изисква от вас да използвате пространството там, но MySQL го използва, за да избегне проблеми с команди като SELECT 10–1.
Select * from users ; -- this will list usersКоментиране с помощта на символите / * и * /
Това многоредово коментиране, за разлика от предишните два примера, не трябва да спира в края на реда.
Select * from users ; /* this will list users */Изпълними коментари
По правило коментарите се игнорират от всеки, който е от другата страна (защото са само за програмисти), но някои типове коментари – изпълними коментари – позволяват на кода да се изпълнява на някои системи.
В нашия случай изпълнимите коментари ви позволяват да използвате SQL кодове, които ще се изпълняват само в MYSQL, а не в други бази данни.
Изпълнимите коментари трябва да се съдържат в наклонени черти със звездичка , както при обичайния код:
/*! Специфичен за MySQL код */
Тези изпълними коментари обаче изискват специфичен синтаксис като по-долу:
/*!##### Специфичен за MySQL код */
Нуждаете се от !##### част за сигнализиране на изпълними коментари. Представлява минималната версия на MYSQL, която може да изпълнява коментари.
Вместо първия хеш, заменете основната версия на MYSQL. Вместо втората, по-младата версия и версиите на пластира се заменят с последните 2.
Само MySQL 5.1.10 или по-нова версия може да изпълнява следните коментари:
CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */
Заключение
Коментарите правят програмите по-лесни за четене, като добавят повече подробности. Можете да мислите за тях като донякъде подобни на хешовете – те намаляват времето, необходимо за разбиране на кода или идентифицират драстично някои части от него, като предоставят фрагменти, които улавят същността на текста. Ако някога сте работили с доказателства без знание или сте се опитвали да влезете във Facebook чрез Google, ще разберете какво имаме предвид.
Ето защо е важно да коментирате кода си и да знаете как да го направите правилно. Поддържането на кода ви точен с информативни бележки улеснява живота на всички участващи специалисти.
