In order to provide documentation for other people who read your DI code, it is helpful to include comments. This is especially important as the size and complexity of your DI pages increase.

In general, comments begin with the # character. Anything from this point until the next end-of-line character is ignored. Comments are generally most useful when using command continuation.

Here is an example of how you might use comments to make code more readable:

<!--.cgivars;                              # read CGI form variables
ifdef myname;                              # if the variable myname was passed in the form
   echo "Your name is $myname"; 
else;                                      # myname not passed in the form
   echo "You didn't tell me your name";
endif-->

Top | Next Page