74 votes

Exemples d'en-tête de commentaire SQL

J'aimerais juste voir à quoi ressemblent les en-têtes de commentaires des procédures stockées/fonctions etc... (alors postez vos exemples)... Je n'ai vraiment vu que ce que le SQL Server Management Studio crée mais je suis intéressé par ce à quoi ressemblent les autres... le formatage, les caractères utilisés, les informations/détails de la procédure etc... je suppose que c'est ce qui les rend vraiment différents...

En-tête de commentaire par défaut de la procédure stockée de SQL Server Management Studio (version 9) :

-- =============================================
-- Author:      Name
-- Create date: 
-- Description: 
-- =============================================

7 votes

N'utilisez jamais les commentaires de ligne (--), utilisez les commentaires de bloc (/* */) si vous avez un problème avec le formatage des lignes, vous serez dans l'enfer des commentaires.

1 votes

Pourriez-vous nous en dire plus @GabrielGuimarães ? J'ai beaucoup de scripts avec des commentaires de ligne et je n'étais pas au courant de cela avant : à quoi dois-je faire attention ?

0 votes

@GabrielGuimarães Management Studio possède une fonction appelée "Commenter les lignes sélectionnées" qui ajoute un commentaire de ligne à toutes les lignes sélectionnées. La fonction inverse "Décommenter les lignes sélectionnées" supprime le commentaire de ligne de tête de toutes les lignes sélectionnées. Cela fonctionne assez bien pour moi. Quels problèmes de formatage de ligne rencontrez-vous ?

1voto

tviscon2 Points 88

Voici ma variante préférée :

/* =====================================================================
DESC:   Some notes about what this does
           tabbed in if you need additional lines
NOTES:  Additional notes
           tabbed in if you need additional lines
======================================================================== */

0voto

Calmar Points 233
-- Author: 
--
-- Original creation date: 
--
-- Description:

0voto

chazbot7 Points 366

Voici ce que j'utilise actuellement. Le triple commentaire ( / * / * / * ) est destiné à une intégration qui extrait les commentaires d'en-tête de la définition de l'objet.

/*/*/*

    Name:           pr_ProcName
    Author:         Joe Smith
    Written:        6/15/16
    Purpose:        Short description about the proc.

    Edit History:   6/15/16 - Joe Smith
                        + Initial creation.
                    6/22/16 - Jaden Smith
                        + Change source to blahblah
                        + Optimized JOIN
                    6/30/16 - Joe Smith
                        + Reverted changes made by Jaden.

*/*/*/

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X