$ASSERTS - mkilgore/QB64pe GitHub Wiki

The $ASSERTS metacommand enables debug tests with the _ASSERT macro.

$ASSERTS

$ASSERTS:CONSOLE

• This metacommand does not require a comment or REM before it. There is no space between the metacommand name, the colon and the CONSOLE parameter.
• If this metacommand is used in a program and any of the set _ASSERT checkpoints will fail, then the program will stop with an _ASSERT failed error.
• Detailed error messages passed to the _ASSERT statement will be displayed in the console window, but only if $ASSERTS:CONSOLE is used.

Note: This metacommand is the main switch to enable debug tests during development. Later just remove this metacommand to compile the program without debugging code, all the _ASSERT statements may remain in the code for later debugging sessions, they are simply ignored without this metacommand.

• QB64 1.4 and up (QB64 Team)
• QBPE 0.5 and up (QB64 Phoenix Edition)

Example:Adding test checks for parameter inputs in a function.

$ASSERTS:CONSOLE

DO
    a = INT(RND * 10)
    b$ = myFunc$(a)
    PRINT a, , b$
    _LIMIT 3
LOOP UNTIL _KEYHIT

FUNCTION myFunc$ (value AS SINGLE)
    _ASSERT value > 0, "Value cannot be zero"
    _ASSERT value <= 10, "Value cannot exceed 10"

    IF value > 1 THEN plural$ = "s"
    myFunc$ = STRING$(value, "*") + STR$(value) + " star" + plural$ + " :-)"
END FUNCTION

• _ASSERT
• $CHECKING
• Relational Operations
• ERROR Codes

Category:Final