• If statements start their test argument on the same line as the declaration and complex statements should be split into multiple lines. 
    If ( 2 + 2 = 4;...

    good 

    If (
  2 + 2 = 4;...

    bad 

    If ( 2 + 2 = 4;
  	True;
// Else
  	False
) // each result should be on its own line

    good 

    If ( 2 + 2 = 4;
	Let ( [
		~A = 2;
		~B = 2
	];
		~A + ~B
	);
// Else
	False
) // embedded functions use indenting so the outer function can still be identified

    good

    Note the use of the simple // Else comment. Using the // Else for better readability is suggested. It follows other language styles where else is part of the syntactic structure
  • When boolean operators are used, they should, when possible, precede the line they are connected to. 
    If ( Evaluate( "Let ( [" & ~contents & "]; False )" ) = "?" // generates an error or
			or ~empty // empty contents
			or ~missingParams; // missing expected parameters

    good 

    If ( Evaluate( "Let ( [" & ~contents & "]; False )" ) = "?" or ~empty or ~missingParams;...

    bad

  • Case statements provide their tests and results on individual lines. Result values are indented from their test. Each new text/result pair should be separated by at least one blank line. Complex calculations can identify their result using a comment on the first line of the result or using a blank line between the test and result. 
    Case (
	2 + 3 = 4;
		False;

	2 + 2 = 4;
		True;

	False // default result on its own line
)

    Case (
	Let ( [
			~A = 2;
			~B = 2
		];
			Let ( $value = ~A + ~B; $value = 4 )
		);

		// result 1
		Substitute (
			"The result is %VALUE and its %CONDITION";
			[ "%VALUE" ; $value ];
			[ "%CONDITION" ; If ( $value = 4; "GOOD"; "BAD") ]
		);

	2 + 2 = 4;
		// result 2
		True;

	False // default result on its own line
)
  • No labels

4 Comments

  1. Anonymous

    My syntax for If looks like this:

    If( Test = True;
  True;
// Else
  False
)

    Similar looks the Case statement:

    Case(
  Test = "A";
    ResultA;
  Test = "B";
    ResultB;
  // Else
    ResultElse
)

    In my opinion, the "// Else" makes it a lot easier to distinguish the individual branches. Especially when one branch is folded into multiple lines:

    If( Test = True;
  "Some text as a prefix "
  & $variable
  & " some text as suffix";
// Else
  "False"
)

    Arnold Kegebein

    1. Matt Petrowsky

      Very nice suggestion! It certainly does increase readability. I've added it above. It's a habit I'll have to get into.

  2. Anonymous

    Should the standard suggest '// Then' after the conditional as well?  I use this especially when I have a multiple conditional; I find it greatly improves my ability to find the end of the conditional and the beginning of the code.  Here's one simple example:

    If (	$CurrentMonth = "June" or
	$CurrentMonth = "July" or
	$CurrentMonth = "August" ;
// Then
	code_if_summer;
// Else
	code_if_not_summer;
)

    -Matthew Miller

    1. Matt Petrowsky

      I would say that either the // Else and the // Then are optional when it comes to the code itself. The indent itself after the test is what sets off the true result. As a variation on what you have above, I suggest putting the joining operator on the following line.

      If ($CurrentMonth = "June"
    or $CurrentMonth = "July"
    or $CurrentMonth = "August";
	
        code_if_summer;
// Else
        code_if_not_summer;
)