Scilab Website | Contribute with GitLab | Mailing list archives | ATOMS toolboxes
Scilab Online Help
5.3.2 - Français

Change language to:
English - 日本語 - Português

Please note that the recommended version of Scilab is 2024.1.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

<< get_function_path Fonctions lib >>

Copyright (c) 2022-2024 (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:
Thu May 12 11:45:02 CEST 2011