Comment

From InterBase
Jump to: navigation, search

Go Up to Procedures and Triggers


Allows programmers to add comments to procedure and trigger code. Available in triggers and stored procedures.

/* comment_text */
Argument Description

<comment_text>

Any number of lines of comment text

Description: Comments can be placed on the same line as code, or on separate lines.

It is good programming practice to state the input and output parameters of a procedure in a comment preceding the procedure. It is also often useful to comment local variable declarations to indicate what each variable is used for.

Example: The following isql procedure fragment illustrates some ways to use comments:

/*
* Procedure DELETE_EMPLOYEE : Delete an employee.
*
* Parameters:
* employee number
* Returns:
* --
*/
CREATE PROCEDURE DELETE_EMPLOYEE (EMP_NUM INTEGER)
AS
DECLARE VARIABLE ANY_SALES INTEGER; /* Number of sales for emp. /*
BEGIN
. . .