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 :
CREATE PROCEDURE ...
BEGIN
-- Description
-- Programmé par :
-- Le :
-- Historique des modifications
-- Par :
-- Le :
-- Modifications :
...
END
Ex :
Dans le cas où il y a des paramètres, l'entête standard doit également préciser en quoi ils consistent :
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.
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
Site fièrement hébergé chez A2 Hosting.