Description Strings for Modules - Maple Help

Online Help

All Products    Maple    MapleSim

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

Description Strings for Modules

Calling Sequence

description str1, str2, ...;


str1, str2, ...


one or more strings



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.


m := module()
    export set, get;
    local val;
    description "a register data structure";
    get := () -> val;
    set := proc(v) val := v end proc;
end module;

m:=modulelocalval;exportset,get;descriptiona register data structure;end module


See Also

module, module[export], module[local], Procedures

Download Help Document

Was this information helpful?

Please add your Comment (Optional)
E-mail Address (Optional)
What is ? This question helps us to combat spam