Description Strings for Modules - Maple Programming Help

Home : Support : Online Help : Programming : Modules : module/description

Description Strings for Modules

 Calling Sequence description str1, str2, ...;

Parameters

 str1, str2, ... - one or more strings

Description

 • A module definition can include a description statement. This is a form of documentation for the module that is embedded in the data structure.
 • The description statement must appear among the "declarative" statements at the beginning of the module definition body.
 • The description statement of a module takes the same form as the description statement of a procedure. The statement begins with the keyword description and is followed by one or more strings that, together, constitute the description of the module.

Examples

 > m := module()     export set, get;     local val;     description "a register data structure";     get := () -> val;     set := proc(v) val := v end proc; end module;
 ${m}{:=}{\mathbf{module}}\left({}\right)\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathbf{local}}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathrm{val}}{;}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathbf{export}}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathrm{set}}{,}{\mathrm{get}}{;}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathbf{description}}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{"a register data structure"}{;}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{}\phantom{\rule[-0.0ex]{0.5em}{0.0ex}}{\mathbf{end module}}$ (1)