Description Strings - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Modules : Description Strings

Description Strings for Modules

 

Calling Sequence

Parameters

Description

Examples

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;

mmodulelocalval;exportset,get;descriptiona register data structure;end module

(1)

See Also

module

module/export

module/local

Procedures