How can I automatically prepend comment blocks to stored procedures?

Question

How can I automatically prepend comment blocks to stored procedures?
In my organization, the standard is to comment all stored procedures with a comment block that looks like this:
/*-- =============================================
-- Created by: <Owner>
-- Created date: 01/08/2012
-- Purpose: Inserts new setting value, code and description
-- Modifications:
-- Modified by: <Owner>
-- Modification date: 01/08/2012
-- Purpose: Inserts new setting value, code and description
-- =============================================*/Thanks.
select * from v$version;
BANNER                                                                        
Oracle Database 11g Express Edition Release 11.2.0.2.0 - Production             
PL/SQL Release 11.2.0.2.0 - Production                                          
CORE     11.2.0.2.0     Production  Edited by: xDeviates on 01-ago-2012 7:37
Edited by: xDeviates on 01-ago-2012 8:31

Answer 1

Hi,
If I want to write a package called pk_fubar, I copy the following script and call it fubar.sql
--     ==========  package_name.sql starts here  ==========
--     Package_Name.sql
SPOOL     &home_dir\package_name.lst
PROMPT     .     H   H  EEEE     A    DDDD
PROMPT     .     H   H  E       A A   D   D
PROMPT     .     HHHHH  EEE    A   A  D   D
PROMPT     .     H   H  E      AAAAA  D   D
PROMPT     .     H   H  EEEEE  A   A  DDDD
@@package_name_head
PROMPT     .     BBBB    OOO   DDDD   Y   Y
PROMPT     .     B   B  O   O  D   D   Y Y
PROMPT     .     BBBB   O   O  D   D    Y
PROMPT     .     B   B  O   O  D   D    Y
PROMPT     .     BBBB    OOO   DDDD     Y
@@package_name_body
SPOOL     OFF
@@package_name_test
-- EXIT
--     ==========  package_name_head.sql starts here  ==========
CREATE OR REPLACE PACKAGE     pk_package_name
AS
FUNCTION     sign_in
(     in_user_name     IN     VARCHAR2
,     in_password_txt     IN     VARCHAR2
RETURN     PLS_INTEGER
END     pk_package_name;
SHOW ERRORS;
GRANT     EXECUTE     ON pk_package_name     TO schema_name_some_role;
--     ==========  package_name_body.sql starts here  ==========
CREATE OR REPLACE PACKAGE BODY     pk_package_name
AS
--  Procedures related to SCHEMA_NAME ...
--  2012 July 23 -- Package started with proc_x.  (Frank Kulash)
--     **   local procedures and variables   **
--     **   x   **
--     **   initialization section   **
--     The following code is executed once per session, when the package is loaded.
BEGIN
     set_var     ( 'DT_FMT_TXT'
          , 'YYYY-MM-DD HH24:MI:SS'
END     pk_package_name;
SHOW ERRORS;
--     ==========  package_name_test.sql starts here  ==========
--     PACKAGE_NAME_TEST.SQL -- Test procedures in schema_name.pk_package_name
SET     DOCUMENT     OFF
SET     SERVEROUTPUT     ON     SIZE     10000
ALTER SESSION     SET NLS_DATE_FORMAT = 'DD-Mon-YYYY HH24:MI:SS';
SPOOL     @@package_name_test.lst
PROMPT
PROMPT     ***********************
PROMPT     **  Testing x  **
PROMPT     ***********************
PROMPT
SPOOL     OFFThen I replace package_name with fubar, and schema_name with the actual schema name. Finally, I cut off parts from the end to create fubar_test.sql, fubar_body.sql and fubar_head.sql. You could easily include a multi-line procedure comment template in this script. Every time you add a procedure or function, ciopy and paste that comment template, and then modify the copy.