Una técnica muy recomendada cuando trabajamos con Bases de Datos al igual que con código y/o desarrollo de aplicaciones y destacada como una de las grandes normas de buenas prácticas de programación es la de comentar y documentar siempre lo que hacemos.
En Transact-SQL (T-SQL) encontramos dos maneras de documentar y comentar nuestros scripts, así como en las instrucciones que utilizamos en nuestras bases de datos ignorar ciertas declaraciones y/o sentencias.
El método que utilicemos dependerá del número de líneas de código que deseemos que sean ignoradas
- Para una sola línea o muy pocas líneas de código utilizamos dos guiones seguidos “
--” que preceden el texto que será marcado o identificado como un comentario. Todo el texto seguido después de los guiones será ignorado por SQL Server. - Para grandes bloques de código que deseamos comentar encerramos el texto entre los caracteres “/*” y “*/”, esto provocará que cualquier sentencia o código ubicado entre estos caracteres sea ignorado por SQL Server.
Vemos unos ejemplos:
Muchos editores de consultas como el SQL Server Management Studio (SSMS) colorean el texto comentado con un color distinto al utilizado por el editor al momento de escribir sentencias para poder diferenciar los comentarios o documentación del resto de las instrucciones escritas.
Es importante recordar que al documentar nuestros códigos no solo cumplimos con las buenas prácticas de programación, sino que con ellos también podremos hacer mantenimiento y correcciones en un futuro.
Como siempre ante cualquier duda o pregunta no dejen de contactarme que con gusto les responderé.
Saludos!
Roberto Pozo
Angaroasoft's Blog 