# - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.

Online Help

All Products    Maple    MapleSim


Comments

 

Description

Examples

Description

• 

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 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.

  

Note: Multi-line comments in 2-D input should only contain text. Certain 2-D math content, such as entries from the palette are not fully supported in 2-D input comments. Use of text entries above or below the 2-D math input is recommended as an alternative, as those lines can include non-executable math.

• 

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.

Examples

x; # A single-line comment.

x

(1)

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

(2)

See Also

backslash

Preprocessor

procedure

quotes

string

symbol