Jak nejlépe využít funkci komentářů v MySQL

Komentáře se používají k přidání informací do kódu. Překladač to většinou ignoruje, ale lidští specialisté si tyto komentáře mohou přečíst, když si prohlížejí váš kód. Komentáře jsou pro vývojáře zásadní, protože mají omezený čas a komentáře jim umožňují získat cenné informace najednou nebo si povšimnout některých zásadních detailů týkajících se kódu. Přístup k těmto datům jim umožňuje činit správná rozhodnutí a pracovat rychleji.

Jak může být pro mě komentáře užitečné?

Komentáře jsou užitečné pro vás osobně a pro kohokoli, kdo si může později tento kód přečíst nebo upravit. Ale jak přesně?

Komentáře mohou být při kódování zástupnými symboly. V tu chvíli byste mohli něco předpokládat a v budoucnu byste věděli, zda je váš předpoklad pravdivý.

Komentáře mohou dokumentovat vaše myšlenky nebo být poznámkami pro vás, abyste na své skutky nezapomněli, až se k nim později vrátíte.

Do svého kódu můžete zahrnout komentáře k tomu, co jste udělali, aby to ostatní programátoři lépe a rychleji pochopili (čas programátorů je velmi, velmi drahý).

Pomocí komentářů můžete dočasně deaktivovat nebo povolit chybné části.

Komentování každého řádku skriptu usnadňuje sledování, kde se v programu mohou nacházet chyby.

Komentáře mohou vysvětlit, co určité řádky kódu dělají, nebo proč jste zvolili nějaký konkrétní přístup, abyste se vyhnuli nedorozuměním (například když jsou některé části kódu určeny pro určitou sekci nebo konkrétní účel, kterému byste měli jasně rozumět) ,

Můžete napsat celý odstavec vysvětlující všechny podrobnosti o sekci kódu, pokud je to potřeba pro nováčky nebo lidi z jiných projektů. Při psaní složitých SQL dotazů s mnoha klauzulemi, jako jsou INNER JOINs, GROUP BY atd., je často potřeba komentáře.

Komentování vám umožňuje dělat si poznámky o tom, co děláte. To pomáhá ostatním pochopit, jak a proč jste něco udělali, aby to mohli udržovat nebo upravovat podle potřeby.

Je SQL dobrý jazyk pro komentáře?

Ano! Komentáře se nejčastěji používají ve spojení s jazyky jako SQL a PHP, kde je můžeme vložit do textového souboru nebo skriptu pomocí funkce komentáře * / (např. /* This is my comment */). Obvykle se stejně snadno používají kdekoli jinde.

Jak komentovat v SQL?

Funkce komentáře vám umožní napsat libovolný text pro přidání komentáře v SQL. Neovlivňuje konečný výstup, pokud přichází před nebo za určitým předem naprogramovaným znakem.

Chcete-li přidat komentáře v SQL, můžete použít následující symboly:/* */ nebo # nebo — (dvojitá pomlčka).

/* */ bude fungovat v každé situaci, kdy chcete začít a ukončit svůj komentář v tomto bodě, aniž byste použili cokoli jiného (jako jednoduché uvozovky).

# se používá pro jeden řádek kódu najednou

— platí také pro jeden řádek kódu najednou. Nezapomeňte za tuto dvojitou pomlčku dát mezeru.

Ve vašem kódu by to vypadalo takto:

-- this is a comment

# this is also a comment

/*
   multiline
   comment
*/

Zde je rozdíl mezi jednořádkovým a víceřádkovým komentářem:

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;

Zde je další příklad víceřádkového komentáře:

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;

Komentování pomocí symbolu #

Základní komentování hash styl lze do textu vložit takto:

Select * from users ; # this will list users

Komentování pomocí dvojité pomlčky (–)

To je víceméně totéž (nezapomeňte na prostor). Standardní SQL ve skutečnosti nevyžaduje, abyste tam používali prostor, ale MySQL jej používá, aby se vyhnul problémům s příkazy jako SELECT 10–1.

Select * from users ; -- this will list users

Komentování pomocí symbolů / * a * /

Tento víceřádkový komentář, na rozdíl od předchozích dvou příkladů, nemusí končit na konci řádku.

Select * from users ; /* this will list users */

Spustitelné komentáře

Komentáře jsou zpravidla ignorovány kýmkoli na druhém konci (protože jsou pouze pro programátory), ale některé typy komentářů – spustitelné komentáře – umožňují běh kódu na některých systémech.

V našem případě vám spustitelné komentáře umožňují používat kódy SQL, které budou spouštěny pouze v MYSQL, nikoli v jiných databázích.

Spustitelné komentáře by měly být obsaženy v lomítcích označených hvězdičkou , jako u obvyklého kódu:

/*! Kód specifický pro MySQL */

Tyto spustitelné komentáře však vyžadují specifickou syntaxi, jako je níže:

/*!##### Kód specifický pro MySQL */

Potřebujete !##### část pro signalizaci spustitelných komentářů. Představuje minimální verzi MYSQL, která může spouštět komentáře.

Místo prvního hashe nahraďte hlavní verzi MYSQL. Namísto druhé verze jsou poslední 2 nahrazeny mladší verzí a verzemi opravy.

Pouze MySQL 5.1.10 nebo novější verze může spouštět následující komentáře:

CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */

Závěr

Komentáře usnadňují čtení programů přidáním dalších podrobností. Můžete si je představit jako něco podobného jako hash – zkracují čas potřebný k pochopení kódu nebo drastické identifikaci některých jeho částí tím, že poskytují úryvky, které zachycují podstatu textu. Pokud jste někdy pracovali s důkazy s nulovými znalostmi nebo se pokoušeli přihlásit na Facebook přes Google, budete vědět, co máme na mysli.

Proto je nezbytné svůj kód komentovat a vědět, jak to udělat správně. Udržování přesného kódu pomocí informativních poznámek usnadňuje životy všech zúčastněných specialistů.