Exemples d'en-tête de commentaire SQL

Question

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: 
-- =============================================

Answer 1

Nous utilisons quelque chose comme ça et c'est très utile pour moi.

/*  
Description:   
Author:   
Create Date: 
Param:   
Return:   
Modified Date:  
Modification:   
*/

Answer 2

-- [why did we write this?]
-- [auto-generated change control info]

Answer 3

set timing on <br>
set linesize 180<br>
spool template.log

/*<br>
##########################################################################<br>
-- Name : Template.sql<br>
-- Date             : (sysdate) <br>
-- Author           :   Duncan van der Zalm - dvdzalm<br>
-- Company          :   stanDaarD-Z.nl<br>
-- Purpose          :   <br>
-- Usage        sqlplus <br>
-- Impact   :<br>
-- Required grants  :   sel on A, upd on B, drop on C<br>
-- Called by        :   some other process<br
##########################################################################<br>
-- ver  user    date        change  <br>
-- 1.0  DDZ 20110622    initial<br>
##########################################################################<br>
*/<br>

sho user<br>

select name from v$database;

select to_char(sysdate, 'Day DD Month yyyy HH24:MI:SS') "Start time"
from dual
;

-- script

select to_char(sysdate, 'Day DD Month yyyy HH24:MI:SS') "End time"
from dual
;

spool off

Answer 4

L'en-tête que nous utilisons actuellement ressemble à ceci :

---------------------------------------------------
-- Produced By   : Our company  
-- URL       : www.company.com  
-- Author        : me   
-- Date      : yesterday    
-- Purpose       : to do something  
-- Called by     : some other process   
-- Modifications : some other guy - today - to fix my bug   
------------------------------------------------------------

D'ailleurs, tous les commentaires que je place dans le SQL utilisent toujours le format :

/* Commentaire */

Comme dans le passé, j'ai eu des problèmes où le script (par le serveur SQL) fait des choses bizarres en enroulant les lignes et en commençant les commentaires -- j'ai commenté le SQL.... requis mais cela pourrait être juste moi.

Answer 5

Voyez si cela correspond à vos besoins :

/*  

* Notes on parameters: Give the details of all parameters supplied to the proc  

* This procedure will perform the following tasks: 
 Give details description of the intent of the proc  

* Additional notes: 
Give information of something that you think needs additional mention, though is not directly related to the proc  

* Modification History:
  07/11/2001    ACL    TICKET/BUGID        CHANGE DESCRIPTION

*/