Jak komentować w SQL

Problem:

Chcesz dodać kilka komentarzy do swojego kodu SQL.

Przykład:

Oto przykładowy kod:

SELECT
  name,
  COUNT(*) AS count_items
FROM products
GROUP BY name
HAVING COUNT(*) > 5
ORDER BY name DESC;

Rozwiązanie 1:

Posługiwać się --. Oto jak to wygląda:

-- product names along with the number of items
-- products ordered by name in descending order
SELECT
  name,
  COUNT(*) -- AS count_items
FROM products
GROUP BY name
-- HAVING COUNT(*) > 5
ORDER BY name DESC;

Dyskusja:

Możesz pisać jednowierszowe komentarze w SQL używając --. Po -- możesz napisać dowolny komentarz, o ile jest w jednym wierszu. Jeśli chcesz napisać komentarz obejmujący wiele wierszy, możesz użyć -- na początku każdego wiersza komentarza, tak jak w przykładzie:

-- product names along with the number of items
-- products ordered by name in descending order

Możesz także użyć -- , aby zakomentować cały wiersz kodu lub część wiersza od jakiegoś miejsca w środku wiersza do końca wiersza. Na przykład możesz zakomentować AS count_item s, ale pozostaw COUNT(*) w.

COUNT(*) -- AS count_items

Zauważ, że kiedy używasz -- komentujesz kod do końca wiersza, więc nie możesz użyć -- do skomentowania, na przykład, tylko słowa kluczowego AS. Jeśli chcesz to zrobić, spójrz na Rozwiązanie 2.

Rozwiązanie 2:

Użyj /*...*/ . Oto jak to wygląda:

/* product names along with the number of items
   this time, the products aren't sorted */
SELECT
  name,
  COUNT(*) /*AS*/ count_items
FROM products
GROUP BY name
/* HAVING COUNT(*) > 5
ORDER BY name DESC */;

Dyskusja:

/*...*/ jest znacznie potężniejszy niż --. Z /*...*/ , możesz zakomentować dowolną część kodu. Komentarz może być wielowierszowy i możesz zdecydować, gdzie się kończy. Po prostu napisz /* na początku komentarza i */ na końcu.

Na przykład możesz zakomentować pojedyncze słowo z kodu, takie jak AS słowo kluczowe:

COUNT(*) /*AS*/ count_items

Możesz też zakomentować dwie linijki, ale nadal zostawiając średnik na końcu:

/* HAVING COUNT(*) > 5
ORDER BY name DESC */;