J2EE Web Hosting - FunnelWeb Manual - J2EE Hosting Provider

3.6 Comments

3.6 Comments

When FunnelWeb encounters the @! sequence during its left to right scan of the

line, it throws away the rest of the line (including the EOL) without analysing it

Tutorial

further. Comments can appear in any line except "

@i

", "

@t

", and "

@p

" lines.

FunnelWeb comments can be used to insert comments into your input file that

Developer

will neither appear in the product files nor in the documentation file, but will be

solely for the benefit of those reading and editing the input file directly.

Reference

Example:

1 Introduction

2 Interface

@! I have used a quick macro for this definition

3 Scanner

@! as it will be used often.

4 Parser

@$@#C@{  @}

5 Analyser

Because comments are defined to include the end of line marker, care must be

6 Tangle

taken when they are being added or removed within the text of macro bodies.

7 Weave

For example the text fragment

8 Shell

9 Commands

for (i=0;i

10 Glossary

   printf("%u\n",a[i]);

11 References

will expand to

SEARCH

for (i=0;i

This problem really has no solution; if FunnelWeb comments were defined to

omit the end of line marker, the expanded text would contain trailing blanks! As

it is, FunnelWeb comments are designed to support single line comments which

can be inserted and removed as a line without causing trouble. For example:

@! Print out a[0..MAXVAL 1].

for (i=0;i

   printf("%u\n",a[i]);

If you want a comment construct that does not enclose the end of line marker,

combine the insert end of line construct @+ with the comment construct @! as

in

for (i=0;i

   printf("%u\n",a[i]);

FunnelWeb comments should really only be used to comment the FunnelWeb

http://www.ross.net/funnelweb/reference/scanner_comments.html (1 of 2) [3/3/2000 10:47:27 PM]

Actions web hosting footer