Jak najlepiej wykorzystać funkcję komentowania w MySQL?

Komentarze służą do dodawania informacji do kodu. Jest on w większości ignorowany przez kompilator, ale specjaliści mogą czytać te komentarze podczas przeglądania kodu. Komentarze są niezbędne dla programistów, ponieważ mają ograniczony czas, a komentowanie pozwala im od razu uzyskać cenne informacje lub zanotować kilka istotnych szczegółów dotyczących kodu. Dostęp do tych danych umożliwia im podejmowanie właściwych decyzji i szybszą pracę.

Jak komentowanie może być dla mnie przydatne?

Komentarze są przydatne dla Ciebie osobiście i dla każdego, kto może później przeczytać lub edytować ten kod. Ale jak dokładnie?

• Komentarze mogą być symbolami zastępczymi podczas kodowania. W tym momencie możesz coś założyć i będziesz wiedział, czy twoje założenie jest prawdziwe w przyszłości.

• Komentarze mogą dokumentować Twoje przemyślenia lub stanowić dla Ciebie notatki, dzięki czemu nie zapomnisz o swoich działaniach, gdy wrócisz do nich później.

• Możesz zamieścić komentarze na temat tego, co zrobiłeś w swoim kodzie, aby inni programiści mogli to lepiej i szybciej zrozumieć (czas programistów jest bardzo, bardzo drogi).

• Możesz użyć komentarzy, aby tymczasowo wyłączyć lub włączyć części zawierające błędy.

• Komentowanie każdej linii skryptu ułatwia śledzenie, gdzie w programie mogą znajdować się błędy.

• Komentarze mogą wyjaśniać, co robią określone wiersze kodu lub dlaczego wybrałeś określone podejście, aby uniknąć nieporozumień (na przykład, gdy niektóre części kodu są przeznaczone dla jakiejś sekcji lub konkretnego celu, który powinieneś jasno zrozumieć) ,

• Możesz napisać cały akapit wyjaśniający wszystkie szczegóły dotyczące sekcji kodu, jeśli jest to potrzebne nowicjuszom lub osobom z innych projektów. Komentowanie jest często potrzebne podczas pisania złożonych zapytań SQL z wieloma klauzulami, takimi jak INNER JOIN, GROUP BY itp.

• Komentowanie umożliwia robienie notatek na temat tego, co robisz. Pomaga to innym zrozumieć, w jaki sposób i dlaczego coś zrobiłeś, aby mogli je konserwować lub modyfikować w razie potrzeby.

Czy SQL jest dobrym językiem do komentarzy?

Tak! Komentarze są najczęściej używane w połączeniu z językami takimi jak SQL i PHP, gdzie możemy wstawić je do pliku tekstowego lub skryptu za pomocą funkcji komentarza * / (np. /* To jest mój komentarz */). Zazwyczaj są one równie łatwe w użyciu gdziekolwiek indziej.

Jak komentować w SQL?

Funkcja komentarza pozwoli Ci napisać dowolny tekst w celu dodania komentarza w SQL. Nie ma to wpływu na końcowy wynik, o ile pojawia się przed lub po określonym wstępnie zaprogramowanym znaku.

Aby dodać komentarze w SQL, możesz użyć następujących symboli:/* */ lub # lub — (podwójna kreska).

/* */ sprawdzi się w każdej sytuacji, w której chcesz rozpocząć i zakończyć swój komentarz w tym momencie bez używania czegokolwiek innego (np. pojedynczego cudzysłowu).

# jest używany dla jednej linii kodu na raz

— dotyczy również jednej linii kodu na raz. Nie zapomnij wstawić spacji po tym podwójnym myślniku.

W twoim kodzie wyglądałoby to następująco:

-- this is a comment

# this is also a comment

/*
   multiline
   comment
*/

Oto różnica między komentarzami jednowierszowymi i wielowierszowymi:

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;

Oto kolejny przykład komentarza wielowierszowego:

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;

Komentowanie za pomocą symbolu #

Podstawowe komentowanie haszujące styl można wstawić do tekstu w następujący sposób:

Select * from users ; # this will list users

Komentowanie za pomocą podwójnego myślnika (–)

To mniej więcej to samo (nie zapomnij o spacji). Standardowy SQL tak naprawdę nie wymaga korzystania z tego miejsca, ale MySQL używa go, aby uniknąć problemów z poleceniami takimi jak SELECT 10–1.

Select * from users ; -- this will list users

Komentowanie za pomocą symboli / * i * /

To wielowierszowe komentowanie, w przeciwieństwie do poprzednich dwóch przykładów, nie musi kończyć się na końcu wiersza.

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

Komentarze wykonywalne

Z reguły komentarze są ignorowane przez każdego po drugiej stronie (ponieważ są przeznaczone tylko dla programistów), ale niektóre typy komentarzy – komentarze wykonywalne – umożliwiają działanie kodu w niektórych systemach.

W naszym przypadku komentarze wykonywalne pozwalają na użycie kodów SQL, które będą wykonywane tylko w MYSQL, a nie w innych bazach danych.

Komentarze wykonywalne powinny być zawarte w ukośnikach oznaczonych gwiazdką , tak jak w przypadku zwykłego kodu:

/*! Kod specyficzny dla MySQL */

Jednak te wykonywalne komentarze wymagają określonej składni, jak poniżej:

/*!##### Kod specyficzny dla MySQL */

Potrzebujesz !##### część do sygnalizowania komentarzy wykonywalnych. Reprezentuje minimalną wersję MYSQL, która może wykonywać komentarze.

Zamiast pierwszego hasha, zastąp główną wersję MYSQL. Zamiast drugiego, młodsza wersja i wersje łatki są zastępowane przez ostatnie 2.

Tylko MySQL 5.1.10 lub nowsza wersja może uruchamiać następujące komentarze:

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

Wniosek

Komentarze ułatwiają czytanie programów, dodając więcej szczegółów. Można je traktować jako nieco podobne do skrótów – skracają czas potrzebny do zrozumienia kodu lub drastycznego zidentyfikowania niektórych jego części, dostarczając fragmenty, które oddają istotę tekstu. Jeśli kiedykolwiek pracowałeś z dowodami z wiedzą zerową lub próbowałeś zalogować się do Facebooka przez Google, będziesz wiedział, co mamy na myśli.

Dlatego ważne jest, aby komentować swój kod i wiedzieć, jak to zrobić poprawnie. Dokładność kodu dzięki informacjom ułatwia życie wszystkim zaangażowanym specjalistom.