...
- Item properties
- All items in PhixFlow have a description property. We recommend you add a description to any item you create.
Anybody looking at a model or application will first look at the descriptions of the items within it. For example, in an analysis model, they should be able to discern the flow and the high-level logic of the model just from the descriptions. - In analysis models, the stream description should explain the use of input or output multipliers. This it typically a significant part of any model.
- Ensure that attributes that represent the same thing in different streams have the same name. PhixFlow needs this when processing merges and for a union in a calculate stream.
- All items in PhixFlow have a description property. We recommend you add a description to any item you create.
- Formatting expressions
- Add comments to document your expression using:
- // for a single line comment
- /* ... */ to enclose multiline comments
- Include blank lines between statements
- Use spaces within expressions
- Indent sub-clauses by 4 spaces
- Add comments to document your expression using:
Naming Conventions
Multi-word stream attribute and pipe names should be in camel case.
Excerpt |
---|
All user-defined variables must start with the $ character.
|
Multi-word stream attribute and pipe names should also be in camel case.
Examples | |
---|---|
stream attribute | MainCompanyName |
pipe | inPipe |
global $-variable | $CompanyLocationCounter |
local $-variable | $companyOldAddress |
Tip |
---|
Camel case uses an uppercase letter for the start of each sub-word, for example |
Layout for if()
if( condition, Statement 1 , // else Statement 2 )
...
To make it easier to see that statements are correctly bracketed, the closing bracket should always line up with the start of the statement.
Layout for switch()
Code Block |
---|
switch( [ condition expression 1, Statement 1 ], [ condition expression 2, Statement 2 ], // default _NULL ) |
...