Comments

Comments

Welcome to our Knowledge Base

Documentation | Blog | Demos | Support

< All Topics
Print

Comments

Comments are descriptive words or sentences, typically used as internal documentation in application programs. Comments are an essential part of application system documentation.

In Zim, the percent sign (%) is used to signal the start of a comment. When the software encounters the comment indicator, it ignores all subsequent characters on the current physical line as shown in the following example:

%————————————
% An example showing the use of comments.
%————————————
form set (not scroll) fPlayers % turn off scrolling
case
   when Event.EventName = ‘F3’ % Process Exit action
      return                   % Terminate the main procedure
   when Event.EventName = ‘F4’ % Process Update action
        UpdatePlayers()
   when Event.EventName = ‘F5’ % Process Add action
        AddPlayers ( PlayersAdded)
   when Event.EventName = ‘F6’ % Process Delete action
        DeletePlayers ( PlayersDeleted)
   when Event.EventName = ‘F7’ % Process Report action
        ReportPlayers()
endcase

To use a percent sign as a literal character rather than as a comment indicator, enclose the percent sign in quotation marks.

Was this article helpful?
5 out of 5 stars

1 rating

5 Stars 100%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.

Leave a Reply

Your email address will not be published. Required fields are marked *

en_CAEnglish