Scilab 5.5.2
- Scilab Help
- Advanced functions
- Built-in & external
- Libraries
- profiling
- argn
- bytecode
- bytecodewalk
- code2str
- comp
- deff
- edit
- exec
- execstr
- fun2string
- funcprot
- function
- functions
- getd
- head_comments
- listfunctions
- macr2lst
- macr2tree
- macro
- macrovar
- mode
- overloading
- recompilefunction
- sciargs
- str2code
- tree2code
- varargin
- varargout
Please note that the recommended version of Scilab is 2025.0.0. This page might be outdated.
See the recommended documentation of this function
head_comments
display Scilab function header comments
Calling Sequence
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
| Report an issue | ||
| << getd | Advanced functions | listfunctions >> |