MySQL Procedures : Standard/Best Place For Code Documentation?
- by rlb.usa
I'd like to put a paragraph or so for documentation on each of my MySQL procedures: date, author, purpose, etc. Is there a standard, accepted, or best place to put this kind of documentation?
For example,
In MSSQL, some IDE's will generate a template for you to start coding your procedure; it comes with a little place for code documentation.
USE [MyDatabase] GO
/****** Object: StoredProcedure [dbo].[StoreRecord] Script Date: 04/29/2010 09:21:57 ******/
SET ANSI_NULLS ON GO
SET QUOTED_IDENTIFIER ON GO
-- =============================================
-- Author:
-- Create date:
-- Description:
-- =============================================
ALTER PROCEDURE [dbo].[StoreRecord]
-- ... more code ...