PHP Classes

File: htdocs/xoops_lib/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md

Recommend this page to a friend!
  Packages of Michael Beck   Xoops 2.5   htdocs/xoops_lib/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md   Download  
File: htdocs/xoops_lib/vendor/smarty/smarty/docs/designers/language-basic-syntax/language-syntax-comments.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: Xoops 2.5
Modular content management publication system
Author: By
Last change:
Date: 2 months ago
Size: 1,801 bytes
 

Contents

Class file image Download

Comments

Template comments are surrounded by asterisks, and that is surrounded by the delimiter tags like so:

Examples

{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>