Los comentarios SQL en MaxCompute mejoran la legibilidad del código al documentar la lógica directamente en el script. Este tema describe cómo escribir comentarios de una y varias líneas en scripts SQL de MaxCompute.
Limitaciones
Los comentarios de varias líneas no están disponibles en la interfaz de desarrollo de datos de DataWorks.
Para usar comentarios SQL en el cliente local de MaxCompute (odpscmd), la versión de odpscmd debe ser 0.49.0 o posterior.
En el cliente de MaxCompute (odpscmd) y Cloud Shell (odpscmd), es obligatorio usar un punto y coma (
;) para finalizar un comentario de una sola línea. Los comentarios de varias líneas no admiten puntos y coma.
Sintaxis
Comentarios de una sola línea
Inicie un comentario de una sola línea con --. Todo el texto desde -- hasta el final de la línea se considera comentario.
-- Comment contentColoque el comentario en una línea independiente encima del código o al final de una línea de código.
En la interfaz de análisis SQL de la consola de MaxCompute o en la interfaz de desarrollo de datos de DataWorks, use Ctrl+/ para comentar una línea de código.
Comentarios de varias líneas
Use /* para abrir y */ para cerrar un comentario de varias líneas; esto permite comentar un bloque de contenido completo a la vez.
/*
Comment
content
*/MaxCompute también admite /*+...*/ como sintaxis de Hint; por ejemplo, MAPJOIN hints y SKEWJOIN HINT. Los hints tienen prioridad sobre los comentarios de varias líneas. Para evitar ambigüedades, utilice /** en lugar de /* como símbolo de apertura en los comentarios de varias líneas.
Ejemplos
A continuación se presentan ejemplos que usan my_table como tabla existente.
Comentario de una sola línea
El siguiente ejemplo muestra un comentario de una sola línea colocado encima de una sentencia y al final de una línea:
-- Single-line comment
DESC my_table; -- Single-line commentComentario de varias líneas
El siguiente ejemplo muestra un comentario de varias líneas integrado en una sentencia SELECT:
SELECT /* Valid
multi-line
comment
*/ * FROM my_table;Error común: /*+ interpretado como Hint
Si abre un comentario de varias líneas con /*+, MaxCompute lo interpreta como el inicio de un Hint en lugar de un comentario:
SELECT /*+ Invalid
multi-line
comment
*/ * FROM my_table;Para evitarlo, utilice /** como símbolo de apertura en los comentarios de varias líneas.