aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md')
-rw-r--r--vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md
new file mode 100644
index 000000000..43104dbb6
--- /dev/null
+++ b/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md
@@ -0,0 +1,71 @@
+Comments {#language.syntax.comments}
+========
+
+Template comments are surrounded by asterisks, and that is surrounded by
+the [delimiter](#variable.left.delimiter) tags like so:
+
+::: {.informalexample}
+
+ {* this is a comment *}
+
+
+:::
+
+Smarty comments are NOT displayed in the final output of the template,
+unlike `<!-- HTML comments -->`. These are useful for making internal
+notes in the templates which no one will see ;-)
+
+
+ {* I am a Smarty comment, I don't exist in the compiled output *}
+ <html>
+ <head>
+ <title>{$title}</title>
+ </head>
+ <body>
+
+ {* another single line smarty comment *}
+ <!-- HTML comment that is sent to the browser -->
+
+ {* this multiline smarty
+ comment is
+ not sent to browser
+ *}
+
+ {*********************************************************
+ Multi line comment block with credits block
+ @ author: bg@example.com
+ @ maintainer: support@example.com
+ @ para: var that sets block style
+ @ css: the style output
+ **********************************************************}
+
+ {* The header file with the main logo and stuff *}
+ {include file='header.tpl'}
+
+
+ {* Dev note: the $includeFile var is assigned in foo.php script *}
+ <!-- Displays main content block -->
+ {include file=$includeFile}
+
+ {* this <select> block is redundant *}
+ {*
+ <select name="company">
+ {html_options options=$vals selected=$selected_id}
+ </select>
+ *}
+
+ <!-- Show header from affiliate is disabled -->
+ {* $affiliate|upper *}
+
+ {* you cannot nest comments *}
+ {*
+ <select name="company">
+ {* <option value="0">-- none -- </option> *}
+ {html_options options=$vals selected=$selected_id}
+ </select>
+ *}
+
+ </body>
+ </html>
+
+