MySQL Procedures : Standard/Best Place For Code Documentation? -

-

i'd put paragraph or documentation on each of mysql procedures: date, author, purpose, etc. is there standard, accepted, or best place put kind of documentation?

for example, in mssql, ide's generate template start coding procedure; comes little place 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 ...

mysql provides short (64 character) comment associated each stored procedure (function) displayed part of show create procedure (or function) results. beyond comments in code write defined stored procedures , functions stripped when mysql parses them. example:

mysql> delimiter // mysql> create function simpleexample( cid int )          returns int comment 'returns argument plus 5'          /* ===============             none of comment gets stored in database.             =============== */        begin            return cid + 5;        end// mysql> delimiter ; mysql> show create function simpleexample;  +---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | function      | sql_mode | create function                                                                                                                                                             | +---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | simpleexample |          | create definer=`ovis`@`localhost` function `simpleexample`( cid int ) returns int(11)     comment 'returns argument plus 5'    begin        return cid + 5;    end |  +---------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+  mysql> select simpleexample(8); +------------------+ | simpleexample(8) | +------------------+ |               13 |  +------------------+ 1 row in set (0.00 sec)

i know of no other standard including documentation part of stored procedures , functions. there plenty of people document code, of course, each project has own practices. if you're used to, stick it; there's nothing preventing same comments working in mysql. if want way locate comments function in live database, might consider using comment characteristic point file+revision in source code containing original definition of function additional comments exist.


Comments

Post a Comment

Popular posts from this blog

javascript - Enclosure Memory Copies -

-
function myclass() { //lots , lots of vars , code here. this.bar = function() { //do numerous enclosed myclass vars } this.foo = function() { alert('hello'); //don't enclosed variables. } } each instance of myclass gets own copy of bar , foo, why prototyped methods use less memory. however, know more memory use of inner methods. it seems obvious me (1) below must true. agree? not distinct myclass instances have own distinct copies of bar, must have own distinct copies of myclass enclosure. (or else how bar method keep myclass variables straight on per instance basis?) now (2) question i'm after. since inner foo method doesn't use in myclass enclosure natural qustion is: javascript smart enough not keep myclass enclosure in memory use of foo? this depend entirely on implementation not language. naive implementations keep far more around others. answer true e.g. v8 (chrome's js engine) may not true spider...
Read more

php - Replacing tags in braces, even nested tags, with regex -

-
example preg_replace('/\{[a-za-z.,\(\)0-9]+\}/', 'replaced', 'lorem ipsum dolor sit {tag1({tag2()})}, consectetur adipiscing elit.'); the result: lorem ipsum dolor sit {tag1(replaced)}, consectetur adipiscing elit. question as can see "tag2" has been replaced, want replace "tag1" know how can this? (in cases might this: {tag1({tag2({tag3()})})}) , on.) btw using preg_replace_callback, easier show preg_replace here site can test code: http://www.spaweditor.com/scripts/regex/index.php you need add curly braces character set. here's pattern used: /\{[a-za-z.,\(\)\{\}0-9]+\}/ and here result: "lorem ipsum dolor sit replaced, consectetur adipiscing elit."
Read more