Such grouping is reflected in the GUI, which could make the tree-view of the project more manageable.Įven without comments, it may be clearer to group related items (parameters, actions,…) in this way. However, a block could also be used to help delimit the scope of a comment.Īlthough this is obviously more verbose. Often this marks a semantic boundary, is associated with control flow, or allows a compound construct in a context where a simple construct is expected. There are places where a group can be used. These may even be viewed in the GUI when you “edit the XML code”. Use XML-style comments to help explain sections of the installer. In most places, comments will be preserved. Here I make some suggestions for trying to keep BitRock sources readable. (Also beware that hand-edited files are not automatically re-loaded by the GUI you must do this explicitly.) For example, in many cases element siblings are rearranged into a sorted order. This helps distinguish user-defined functions from any built-in functionality.Although BitRock InstallBuilder has a GUI, it is also practical to edit the sources, which are XML files, in an editor.īeware that when you save the sources from the GUI, hand-edited files may be reorganised.
I tend to name my functions with ‘function’ as a prefix, and to place my functions in a file named closely to the function’s name.
It is possible to define common actions in functions. The latter will always keep the related logic together. I tend to use the latter, even though it’s a little more verbose, as siblings tend to get separated (sometimes even if the tag names are alphabetically close). orīut this may also be expressed on an attribute of a rule group The evaluation logic for a rule list may be expressed in a sibling as, e.g. This tends to be useful when searching the sources. I tend to use the former to declare, define or initialise an important symbol (parameter, variable, function,…), and the latter for ordinary assignments and for temporary, local or minor symbols. In BitRock elements, properties may often be expressed either as a child or as an attribute.
Although BitRock InstallBuilder has a GUI, it is also practical to edit the sources, which are XML files, in an editor.īeware that when you save the sources from the GUI, hand-edited files may be reorganised.
0 kommentar(er)
