Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: English - Português - 日本語

Please note that the recommended version of Scilab is 6.0.0. This page might be outdated.
See the recommended documentation of this function

Aide Scilab >> Fonctions > head_comments

head_comments

display scilab function header comments

Calling Sequence

head_comments(name)
head_comments(name,%paths)

Arguments

name

character string, the function name

%paths

character string vector, paths where to look for the asscoated sci-file

Description

comments(name) displays the function header comments (like the Matlab help). The comments are read from the associated sci-file. If name if a function in a library the sci-file path is those given by the library path (see lib). If name if a function which is not in a library, a file with name name.sci is searched in the directories given by the variable %paths

Warning, most of the scilab predefined functions have no header comments.

Examples

head_comments sinc

See Also

  • help — commande d'aide en ligne

Authors

Serge Steer, INRIA

Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Wed Oct 05 12:11:04 CEST 2011