2023-02-06 10:40:00 +01:00
|
|
|
# Comments
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
Template comments are surrounded by asterisks, and that is surrounded by
|
2023-08-09 00:10:41 +02:00
|
|
|
the [delimiter](../../designers/language-basic-syntax/language-escaping.md) tags like so:
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
## Examples
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{* this is a comment *}
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
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 ;-)
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{* I am a Smarty comment, I don't exist in the compiled output *}
|
|
|
|
|
<html>
|
2021-12-03 11:59:22 +01:00
|
|
|
<head>
|
2023-02-06 10:40:00 +01:00
|
|
|
<title>{$title}</title>
|
2021-12-03 11:59:22 +01:00
|
|
|
</head>
|
2023-02-06 10:40:00 +01:00
|
|
|
<body>
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
{* 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>
|
2023-02-06 10:40:00 +01:00
|
|
|
</html>
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
