Cómo hacer comentarios en SQL

Descubre la importancia de expresarte en SQL más allá de las consultas. Aprende cómo hacer comentarios en tus bases de datos para dar contexto y claridad a tu código. ¡Potencia tus habilidades y convierte tu SQL en una comunicación efectiva!

Comentar varias líneas en SQL

En SQL, para comentar varias líneas de código se suele usar /* para abrir el comentario y */ para cerrarlo. Este tipo de comentarios permiten incluir múltiples líneas de texto descriptivo o explicativo en el script SQL sin que sean interpretadas como parte del código a ejecutar.

Por ejemplo:

/* Este es un comentario
que abarca varias líneas
en SQL */
SELECT columna 
FROM tabla;

La sintaxis para comentar varias líneas en SQL mediante el uso de /* y */ es ampliamente reconocida y utilizada en la mayoría de sistemas de gestión de bases de datos que soportan SQL, como MySQL, PostgreSQL, Oracle, SQL Server, entre otros.

Cómo añadir comentarios en SQL Workbench

Para añadir comentarios en SQL Workbench, puedes utilizar el estándar de comentario de una sola línea con «–» seguido del comentario. También es posible utilizar el formato de comentarios de varias líneas con «/*» para abrir el comentario y «*/» para cerrarlo. Los comentarios en SQL Workbench son muy útiles para documentar el código y hacer que sea más legible y comprensible para otros programadores o para ti mismo en el futuro.

Algunos consejos importantes para añadir comentarios en SQL Workbench son:

Utilizar comentarios para explicar la lógica del código o detalles importantes.
Evitar comentarios innecesarios que puedan confundir en lugar de aclarar.
Mantener los comentarios actualizados conforme se modifican o añaden nuevas partes al código.

Cómo ver los comentarios de una tabla en SQL Server

Para ver los comentarios de una tabla en SQL Server, es importante tener en cuenta que **en SQL Server no existe una funcionalidad nativa para añadir comentarios a tablas o columnas** como en otros sistemas de gestión de bases de datos. Sin embargo, se pueden utilizar algunas estrategias para documentar los objetos de la base de datos.

Una forma común de añadir comentarios o documentación a una tabla en SQL Server es **a través de las propiedades extendidas**. Las propiedades extendidas permiten añadir metadatos a los objetos de la base de datos, lo que puede incluir información descriptiva o comentarios sobre una tabla o columna en particular.

A continuación, se muestra un ejemplo de cómo se podrían crear y ver comentarios utilizando propiedades extendidas en SQL Server:

**Crear un comentario para una tabla:**

EXEC sys.sp_addextendedproperty @name = N'MS_Description',
                                @value = 'Descripción de la tabla',
                                @level0type = N'SCHEMA', @level0name = 'dbo',
                                @level1type = N'TABLE',  @level1name = 'NombreTabla';

**Ver los comentarios de una tabla:**

SELECT obj.name AS TableName, 
       ep.name AS PropertyName, 
       ep.value AS PropertyValue
FROM sys.tables AS obj
LEFT JOIN sys.extended_properties AS ep ON ep.major_id = obj.object_id AND ep.minor_id = 0
WHERE obj.name = 'NombreTabla';

Otra opción es **mantener la documentación por fuera de la base de datos**, ya sea en un documento de Word, en una herramienta de control de versiones o en un sistema de gestión de documentación técnica.

Ver más Preguntas de entrevista para ingenieros de front end

Recuerda que **es importante mantener actualizada la documentación y los comentarios de las tablas**, ya que facilita la comprensión y el mantenimiento de la base de datos a lo largo del tiempo.

Espero que esta guía te haya sido útil para aprender a hacer comentarios en SQL. Recuerda que los comentarios son una herramienta clave para documentar y explicar tu código, ¡sigue practicando y mejorando tus habilidades en SQL! ¡Hasta la próxima!