Formation PUB200 : MySQL, 2018 Les procédures et fonctions stockées

15.16 Entête standard


Il est important d'ajouter un entête standard à chaque procédure ou fonction stockée. En effet, puisque le code est enregistré directement dans la BD, le commentaire devient le seul moyen de savoir à quelle date le code a été modifié ou encore de quelle version il s'agit.

▼Publicité Le texte se poursuit plus bas

Toutes vos procédures stockées et toutes vos fonctions stockées devront débuter par les commentaires suivants placés juste après le BEGIN :

MySQL

CREATE PROCEDURE ...
BEGIN
    -- Description 
    -- Programmé par :
    -- Le :
    -- Historique des modifications

    -- Par :
    -- Le :
    -- Modifications :
    ...
END

Ex :

Entete standard

Dans le cas où il y a des paramètres, l'entête standard doit également préciser en quoi ils consistent :

MySQL

CREATE PROCEDURE ...
BEGIN
    -- Description :
    -- Programmé par :
    -- Le :
    -- Paramètres :
    --     INT (OUT) : nombre de réparations 

    -- Historique des modifications 
    -- Par : 
    -- Le : 
    -- Modifications : 
    ...
END

Et pour les fonctions stockées, il faut préciser la nature de la valeur de retour.

MySQL

CREATE FUNCTION ... RETURNS ...
READS SQL DATA
BEGIN
    -- Description 
    -- Programmé par :
    -- Le :
    -- Paramètres :
    --     INT : identifiant du client
    -- Valeur de retour : true si ...
    -- Historique des modifications 
    -- Par : 
    -- Le : 
    -- Modifications : 
    ...
    RETURN ...
END

Veuillez noter que le contenu de cette fiche vous est partagé à titre gracieux, au meilleur de mes connaissances et sans aucune garantie.
Par Christiane Lagacé
Dernière révision le 26 mai 2022
Merci de partager !

Site fièrement hébergé chez A2 Hosting.

Soumettre