HelpSource/Tutorials/Mark_Polishook_tutorial/03_Comments.schelp

   1 title:: 03_Comments
   2 summary:: Mark Polishook tutorial
   3 categories:: Tutorials>Mark_Polishook_tutorial
   4 related:: Tutorials/Mark_Polishook_tutorial/00_Introductory_tutorial
   5
   6 section::Comments
   7
   8 Comments are descriptive remarks that are meant to be read by humans but ignored by computers. Programmers use comments to annotate how code works or what it does. It's also the case that some find it helpful to write programs by first notating comments and then filling in matching code.
   9
  10 ////////////////////////////////////////////////////////////////////////////////////////////////////
  11
  12 To write a comment in SuperCollider, either precede text with
  13
  14 code::
  15 //
  16 ::
  17
  18 as in
  19
  20 code::
  21 // Everything up to the end of the line is a comment
  22 ::
  23
  24 or place text on one or more lines between
  25
  26 code::
  27 /* and */
  28 ::
  29
  30 as in
  31
  32 code::
  33 /*
  34
  35 This
  36 is
  37 a
  38 comment
  39
  40  */
  41 ::
  42
  43 If (when) evaluated, a comment will return nil, which is the value SuperCollider uses for unitialized data.
  44
  45 ////////////////////////////////////////////////////////////////////////////////////////////////////
  46
  47 Use Format->Syntax Colorize (or cmd-') to syntax-colorize comments.
  48
  49 ////////////////////////////////////////////////////////////////////////////////////////////////////
  50
  51 go to link::Tutorials/Mark_Polishook_tutorial/04_Help::