SQL kommentit niillä on keskeinen rooli parantamisessa luettavuus huollettavuus ja dokumentaatio SQL-koodistamme. Käyttämällä kommentteja tehokkaasti kehittäjät voivat tarjota kontekstin selventää monimutkaista logiikkaa ja poista koodin osia tilapäisesti käytöstä. Työskentelemme sitten yksin tai yhdessä tiimin kanssa SQL-kommenttien käyttö voi parantaa merkittävästi laatu ja selkeys meidän tietokantakyselyt .

Tässä artikkelissa selitämme erityyppisiä SQL-kommentteja: yhden rivin kommentit monirivisiä kommentteja ja in-line kommentit . Tutkimme myös niiden syntaksia, annamme esimerkkejä ja keskustelemme parhaista käytännöistä SQL-kommenttien käyttämiseksi kyselyissämme.

Mitä ovat SQL-kommentit?

SQL kommentit ovat SQL-koodimme huomautuksia, joita ei suorita tietokantamoottori . Ne palvelevat mm muistiinpanoja tai selityksiä ihmislukijoita helpottaa sitä ymmärtää ja ylläpitää koodia . Selitämmekö monimutkaista logiikkaa tarjoamalla kontekstin kyselylle tai poistamalla väliaikaisesti osan koodikommenteistamme välttämätön työkalu mille tahansa kehittäjälle.

SQL-kommenttien tyypit

SQL-kommentit selittää SQL-lauseiden osia tai estää SQL-lauseet teloituksesta. Nämä ovat kolme kommentointimenetelmää SQL:ssä jokaisella on ainutlaatuinen käyttö. Keskustellaan näistä SQL-kommenteista yksityiskohtaisesti alla:

Niitä on 3 kommenttityyppejä SQL:ssä :

1. Yksirivisiä kommentteja
2. Monirivisiä kommentteja
3. In-line kommentit

1. Yksiriviset SQL-kommentit

Yksirivisiä kommentteja käytetään merkitsemään yksi SQL-koodirivi. Heidät työllistetään usein lyhyitä selityksiä tai siihen poistaa koodirivit väliaikaisesti käytöstä poistamatta niitä. Yksirivisiä kommentteja alkaa kaksi väliviivaa (--) ja kommentti jatkuu rivin loppuun asti.

Syntaksi:

-- yksirivinen kommentti

Esimerkki

SELECT * FROM        customers;   

Selitys:

Tässä esimerkissä kommentti-- query to fetch customer recordsselittää kyselyn tarkoituksen, joka on hakea kaikki tietueet kohteesta Asiakkaat taulukko.

2. SQL-moniriviset kommentit

Monirivisiä kommentteja käytetään tarvittaessa kommentoida ulos useampi kuin yksi rivi SQL-koodia. Nämä kommentit ovat välissä /* ja */ ja voi kattaa useita rivejä. Niitä käytetään tyypillisesti pidempiä selityksiä tai poistaa suuremmat koodin osat väliaikaisesti käytöstä.

Syntaksi:

/* monirivinen kommentti
toinen kommentti */

Esimerkki

SELECT *   
FROM orders   
WHERE YEAR(order_date) = 2022;  

Selitys :

Tässä esimerkissä monirivinen kommentti selittää, että kysely hakee kaikki vuonna 2022 tehdyt tilaukset tilauksia taulukko.

3. SQL-linjan kommentit

In-line kommentit anna meidän lisätä kommentteja itse kyselyn sisällä. Niitä käytetään yleensä tarjoamaan lisätietoja tai selityksiä kyselyn tietyille osille keskeyttämättä SQL-käskyn kulkua. In-line kommentit aloita kanssa/*ja lopuksi*/.

Syntaksi:

SELECT * FROM /* Asiakkaat; */ 

Esimerkki

SELECT customer_name   
order_date  
FROM orders;

Selitys :

Tässä esimerkissä on-line kommentteja käytetään kuvaamaan tarkoitustacustomer_namejaorder_datesarakkeita. Tämä lähestymistapa pitää koodin luettavana ja auttaa tulevia kehittäjiä ymmärtämään logiikkaa nopeasti.

Tärkeitä seikkoja SQL-kommenteista

Vaikka SQL-kommentit ovat tärkeitä koodin dokumentoinnissa, niitä käytettäessä on noudatettava useita parhaita käytäntöjä:

1. Ole ytimekäs mutta selkeä : Pidä kommentit lyhyinä mutta kuvaavina. Vältä tarpeettomia kommentteja, jotka eivät lisää koodin arvoa.
   
2. Selitä monimutkaiset kyselyt : Käytä kommentteja selittääksesi, miksi tietyt päätökset tehtiin erityisesti monimutkaisten kyselyjen tai liiketoimintalogiikan vuoksi.
   
3. Vältä ilmeisen koodin kommentoimista : Älä kommentoi triviaaleja tai itsestään selviä koodeja. Ei esimerkiksi tarvitse kommentoida yksinkertaista SELECT-lauseet selkeillä sarakkeiden nimillä.
   
4. Käytä kommentteja poistaaksesi koodin väliaikaisesti käytöstä : Kommentteja käytetään usein "kommentoimaan" SQL-koodin osia, jotka on testattava tai poistettava tilapäisesti käytöstä.
   
5. Johdonmukainen muotoilu : Käytä yhtenäistä tyyliä kommenteissasi koko SQL-koodikannassasi. Tämä helpottaa koodin lukemista ja ymmärtämistä erityisesti työskennellessäsi tiimin kanssa.

Johtopäätös

SQL kommentit ovat olennainen työkalu kaikille kehittäjä kanssa tietokannat . Niiden avulla voimme merkitä koodimme, mikä helpottaa sitä ymmärtää ylläpitää ja debug . Käytämmekö yhden rivin kommentit nopeita selityksiä varten monirivisiä kommentteja tarkemmat kuvaukset tai in-line kommentit kyselyn tietyille osille sopivat kommentointikäytännöt parantavat SQL-koodimme selkeyttä.

regexp_like mysql:ssä