Mysql
 sql >> Database >  >> RDS >> Mysql

Come utilizzare al meglio la funzione di commento in MySQL

I commenti vengono utilizzati per aggiungere informazioni al codice. Viene per lo più ignorato dal compilatore, ma gli specialisti umani possono leggere quei commenti quando visualizzano il codice. I commenti sono essenziali per gli sviluppatori perché hanno un tempo limitato e i commenti consentono loro di ottenere informazioni preziose in una volta o di annotare alcuni dettagli cruciali per quanto riguarda il codice. L'accesso a questi dati consente loro di prendere le decisioni giuste e lavorare più velocemente.

In che modo commentare può essermi utile?

I commenti sono utili per te personalmente e per chiunque abbia bisogno di leggere o modificare questo codice in un secondo momento. Ma come esattamente?

  • I commenti possono essere segnaposto durante la codifica. In quel momento potresti presumere qualcosa e sapresti se la tua ipotesi è vera in futuro.
  • I commenti possono documentare i tuoi pensieri o essere appunti per te stesso in modo che non dimenticherai le tue azioni quando tornerai su di loro in seguito.
  • Puoi includere commenti su ciò che hai fatto nel tuo codice affinché altri programmatori lo capiscano meglio e più velocemente (il tempo dei programmatori è molto, molto costoso).
  • Puoi utilizzare i commenti per disabilitare o abilitare temporaneamente le parti difettose.
  • Commentare ogni riga di uno script rende più semplice tenere traccia di dove potrebbero trovarsi i bug all'interno del programma.
  • I commenti possono spiegare cosa stanno facendo determinate righe di codice o perché hai scelto un approccio particolare per evitare malintesi (ad esempio, quando alcune parti del codice sono destinate a una sezione o a uno scopo particolare che dovresti capire chiaramente) ,
  • Puoi scrivere un intero paragrafo spiegando tutti i dettagli sulla sezione del codice, se necessario per i neofiti o per le persone di altri progetti. I commenti sono spesso necessari quando si scrivono query SQL complesse con molte clausole come INNER JOIN, GROUP BY, ecc.
  • I commenti ti consentono di prendere appunti su ciò che stai facendo. Questo aiuta gli altri a capire come e perché hai fatto qualcosa in modo che possano mantenerla o modificarla secondo necessità.

SQL è un buon linguaggio per i commenti?

Sì! I commenti vengono spesso utilizzati insieme a linguaggi come SQL e PHP, dove possiamo inserirli in un file di testo o in uno script utilizzando la funzione di commento * / (ad es. /* Questo è il mio commento */). In genere sono altrettanto facili da usare anche altrove.

Come commentare in SQL?

La funzione di commento ti consentirà di scrivere qualsiasi testo per aggiungere un commento in SQL. Non influisce sull'output finale fintanto che precede o segue un determinato carattere preprogrammato.

Per aggiungere commenti in SQL, puoi utilizzare i seguenti simboli:/* */ o # o — (doppio trattino).

/* */ funzionerà per qualsiasi situazione in cui desideri iniziare e terminare il tuo commento a quel punto senza utilizzare nient'altro (come virgolette singole).

# viene utilizzato per una riga di codice alla volta

— vale anche per una riga di codice alla volta. Non dimenticare di mettere uno spazio dopo questo doppio trattino.

Nel tuo codice sembrerebbe il seguente:

-- this is a comment
# this is also a comment
/*
   multiline
   comment
*/

Ecco la differenza tra i commenti su una riga e su più righe:

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;

Ecco un altro esempio di commento su più righe:

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;

Commentare usando il simbolo #

Il commento hash di base lo stile può essere inserito nel testo in questo modo:

Select * from users ; # this will list users

Commentare usando il doppio trattino (–)

Questo è più o meno lo stesso (non dimenticare lo spazio). L'SQL standard in realtà non richiede che tu usi lo spazio lì, ma MySQL lo usa per evitare problemi con comandi come SELECT 10–1.

Select * from users ; -- this will list users

Commentare utilizzando i simboli / * e * /

Questo commento su più righe, a differenza dei due esempi precedenti, non deve fermarsi alla fine della riga.

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

Commenti eseguibili

Di norma, i commenti vengono ignorati da chi si trova dall'altra parte (perché sono riservati ai programmatori), ma alcuni tipi di commenti - commenti eseguibili - abilitano il codice in esecuzione su alcuni sistemi.

Nel nostro caso, i commenti eseguibili consentono di utilizzare codici SQL che verranno eseguiti solo in MYSQL, non in altri database.

I commenti eseguibili devono essere contenuti all'interno di barre contrassegnate da asterisco , come con il solito codice:

/*! Codice specifico per MySQL */

Tuttavia, questi commenti eseguibili richiedono una sintassi specifica come quella di seguito:

/*!##### Codice specifico per MySQL */

Hai bisogno del !##### parte per segnalare commenti eseguibili. Rappresenta la versione minima di MySQL in grado di eseguire commenti.

Invece del primo hash, sostituisci la versione principale di MySQL. Invece della seconda, la versione più giovane e le versioni della patch vengono sostituite alle ultime 2.

Solo MySQL 5.1.10 o versione successiva può eseguire i seguenti commenti:

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

Conclusione

I commenti facilitano la lettura dei programmi aggiungendo ulteriori dettagli. Puoi considerarli in qualche modo simili agli hash:riducono il tempo necessario per comprendere il codice o identificarne alcune parti in modo drastico fornendo frammenti che catturano l'essenza del testo. Se hai mai lavorato con prove a conoscenza zero o provato ad accedere a Facebook tramite Google, saprai cosa intendiamo.

Ecco perché è essenziale commentare il tuo codice e sapere come farlo correttamente. Mantenere il codice accurato con note informative semplifica la vita di tutti gli specialisti coinvolti.