Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml')
-rw-r--r--doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml b/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
new file mode 100644
index 0000000..908905d
--- /dev/null
+++ b/doc/org.eclipse.jet.doc/references/syntax/jetSyntaxComments.xhtml
@@ -0,0 +1,50 @@
+<?xml version='1.0'?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+
+ <head>
+
+ <title>JET Comment Reference Syntax</title>
+
+ <link charset="ISO-8859-1" href="../../book.css" rel="STYLESHEET"
+ type="text/css"/>
+
+ </head>
+
+ <body>
+
+ <h2>JET Comment Syntax Reference</h2>
+
+ <p>JET templates may contain comments between the characters
+ <code>&lt;%--</code> and <code>--%&gt;</code>. JET ignores all
+ content in a comment. </p>
+
+ <h3>Valid comments</h3>
+
+ <p>Comments may span several lines, and may contain any text. The
+ following are examples of a JET comments:</p>
+
+ <pre>&lt;%-- This comment will not appear in the template output --%&gt;
+&lt;%-- This directive is not used
+&lt;%@taglib id=&quot;org.eclipse.jet.controlTags&quot; prefix=&quot;cc&quot;%&gt;
+--%&gt;</pre>
+ <h3>Invalid comments</h3>
+
+ <p>Comments may not appear within other JET elements. The following
+ are illegal comments:</p>
+
+ <pre>&lt;%@taglib id=&quot;org.eclipse.jet.controlTags&quot; &lt;%-- illegal comment --%&gt;
+ prefix=&quot;cc&quot; %&gt;</pre>
+ <h3>Escaping comment characters</h3>
+
+ <p>To emit the characters <code>&lt;%--</code> in a templates
+ output, enter <code>&lt;\%--</code>. To emit <code>--%&gt;</code>,
+ enter <code>--%\&gt;</code>.</p>
+
+ <p>The following is an example of an escaped JET comments:</p>
+
+ <pre>&lt;\%-- this will show in the template output --%\&gt;</pre>
+ </body>
+
+</html>
+

Back to the top