Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Adopting a common, shared, standard style for all expressions, scripts and macros makes it easier to "read" them and quickly understand what they are doing.

In general, PhixFlow ignores all spacing around the functional elements however . However spacing and layout makes the meaning much clearer for human readers!

This page provides recommended styles for key functional elementswriting expressions.

General

  • 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.
  • 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

...