Name

/** */ (doc comment)

Description

Explanatory notes embedded within the code. Doc comments (documentation comments) are used to describe and document your sketch, classes, and methods. Comments are ignored by the compiler.

Doc comments may be converted into browseable documentation using external editors and tools such as the command line javadoc, doc generators such as Doxygen, or IDEs such as Eclipse, Netbeans, or IntelliJ IDEA.

Examples

  • /**
       Draws two lines which divides the window 
       into four quadrants. First draws a horizontal
       line and then the vertical line 
    */ 
    line(0, 50, 100, 50);
    line(50, 0, 50, 100);
    

Syntax

  • /**
  • comment
  • */

Parameters

  • commentany sequence of characters