Adding comments to blocks (comment)

Synopsis

comment block_id row_number text

showcomments block_id

uncomment block_id row_number

Description

Printable comments may be added to blocks; for example explanations useful to learners; e.g. pass treble in 2-3, dodge 4-5 up. To do this, the comment command should be used after the method has been rung; for example

CRE> method pb5 "Plain Bob" 5
CRE> block plain "Plain Course of Bob Doubles" 5 10
CRE> plaincourse plain pb5
CRE> comment plain 8 "Pass treble in 2-3"
CRE> comment plain 10 "Dodge 3-4 up"
CRE> set plain.commentlen 20
CRE> set plain.showcomments on
CRE> print plain

N.B. The variable showcomments needs to be on and commentlen must be set to the maximum length for comments to be correctly printed.

To list comments, use the showcomment command; for example

CRE> showcomments plain
8 "pass treble 2-3"
10 "Dodge 3-4 up"

To remove comments, the uncomment command may be used; for example to remove the comment on line 8:

CRE> uncomment plain 8