Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
6.0.0 - English

Change language to:
Français - 日本語 - Português - Русский

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

Scilab Help >> Advanced functions > head_comments

head_comments

display Scilab function header comments

Syntax

head_comments(name)
head_comments(name,%paths)

Arguments

name

a character string, the function name.

%paths

a character string vector, paths where to look for the associated sci-file.

Description

head_comments(name) displays the function header comments (like the Matlab help). The comments are read from the associated sci-file. If name is a function which is in a library the sci-file path is those given by the library path (see lib). If name is 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 — on-line help command
  • lib — library definition
Report an issue
<< getd Advanced functions macr2tree >>

Copyright (c) 2022-2023 (Dassault Systèmes)
Copyright (c) 2017-2022 (ESI Group)
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 14 15:03:08 CET 2017