¿Cómo puedo agregar comentarios en MySQL?

130

Quiero agregar comentarios en el código SQL. ¿Cómo puedo hacer esto? Estoy usando MySQL.

mysql database comments amir amir
fuente

Respuestas:

224

Varias formas:

# Comment
-- Comment
/* Comment */

Recuerda poner el espacio después-- .

Ver la documentación .

Martti Laine
fuente
76
Recuerde poner el espacio después--
Pacerier
1
¿Existe alguna guía general de mejores prácticas o estilo sobre cuándo utilizar estas diferentes sintaxis? Obviamente, el último es ideal para comentarios de varias líneas, pero ¿hay alguna regla general para los comentarios de una sola línea?
StockB
3
@StockB no, pero nunca está de más ser coherente con tus estilos de codificación.
gdoron está apoyando a Monica
24

"Se puede especificar un comentario para una columna con la COMMENTopción. El comentario se muestra mediante las declaraciones SHOW CREATE TABLEy SHOW FULL COLUMNS. Esta opción está operativa a partir de MySQL 4.1. (Se permite pero se ignora en versiones anteriores)".

Como ejemplo

--
-- Table structure for table 'accesslog'
--

CREATE TABLE accesslog (
aid int(10) NOT NULL auto_increment COMMENT 'unique ID for each access entry', 
title varchar(255) default NULL COMMENT 'the title of the page being accessed',
path varchar(255) default NULL COMMENT 'the local path of teh page being accessed',
....
) TYPE=MyISAM;
Dinesh Gehlot
fuente
No creo que esto sea lo que OP estaba pidiendo.
user1717828
2
Es lo que estaba buscando :) Por cierto, descubrí que el argumento COMENTARIO tenía que ser antes de cualquier argumento DESPUÉS; El orden es importante, evidentemente.
Soft Bullets
16

Puede usar comentarios de una sola línea:

-- this is a comment
# this is also a comment

O un comentario multilínea:

/*
   multiline
   comment
*/
fivedigit
fuente
3

Desde aquí puedes usar

#  For single line comments
-- Also for single line, must be followed by space/control character
/*
    C-style multiline comment
*/
Diamante negro
fuente
1

Se admiten tres tipos de comentarios.

  1. Hash base de una sola línea comentando usando #

    Select * from users ; # this will list users
    1. Double Dash comentando usando -

    Select * from users ; -- this will list users

Nota: es importante tener un solo espacio en blanco justo después de -

3) Comentarios de varias líneas usando / * * /

Select * from users ; /* this will list users */
Sr. codificador
fuente