Comments - Maple Programming Help

Online Help

All Products    Maple    MapleSim

Home : Support : Online Help : Programming : Expressions : Punctuation : comment







Single line comments are introduced by a pound character (#, sometimes called a hash, sharp, or number sign character). This character and all that follow it on a line comprise a comment, and are discarded by Maple.


If the pound character is enclosed within a pair of left single quotes (a symbol), double quotes (a string), or a multi-line comment, then it is not treated as the beginning of a comment.


If the final character of a comment line is a non-escaped backslash, the comment is continued on the next line.


Multi-line comments are enclosed in (* and *). Multi-line comments are not available in 2-D math.


Multi-line comments may be nested, making the useful for temporarily commenting out blocks of Maple source code that may already contain single or multi-line comments.


If (* appears within a single line comment, it does not begin a multi-line comment, just as # appearing in a multi-line comment does not begin a single line comment.


Maple procedures and modules may also contain a description clause, which is similar to a comment in that its purpose is documentation. However, unlike # comments, the description clause is retained by Maple when the procedure is compiled into Maple's internal form and will be displayed when the procedure is printed.


Note: When 1-D math input is converted to 2-D math input, all comments are discarded. To view all of the comments in the examples below, you must view the page in 1-D math input. In the View menu, ensure that the Display Examples with 2D Math box is not checked.




p := proc(x) description "Descriptions are retained by Maple.";
    # Square x.
    x^2; # Comments are discarded by Maple.
end proc;

pprocxdescriptionDescriptions are retained by Maple.;x^2end proc


See Also