Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: Français - Português - 日本語 - Русский
Scilab Help >> Scilab > Scilab keywords > comments

comments

(// or /*...*/) comments

Description

A sequence of two consecutive slashes // out of a string definition marks the beginning of a comment. The slashes as well as all the following characters up to the end of the lines are not interpreted.

Another way to comment a block of code is to use /* at the beginning and */ at the end. It is more useful than // which must be positioned at the beginning of each line to comment.

Inside a function, the first comment lines, up to the first instruction or an empty line may be used to provide the default contents for the function help.

Examples

g=9.81// the gravity

text='a//b'

/* As this comment is quite long to be on many lines,
the symbols slash and star to start the comment
and star and slash to end the comment are used */

function y=myfunction(x)
  // myfunction computes y=x^2+1
  // x should be a vector or matrix
  y=x^2+1
endfunction

help myfunction

See also

  • head_comments — display Scilab function header comments
  • slash — (/) right division and feed back
  • backslash — (\) left matrix division.

History

VersionDescription
6.0 /* .. */ block comments introduced.
Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Thu Feb 14 14:57:05 CET 2019