Versions Compared

Key

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

As your FinalBuilder project gets larger and more complex , you should document it, to help you and others maintain it in the futuretypically the number of people maintaining the project grows. Typically this means documenting the intent of the scripts so everyone is on the same page. Here are some of the ways FinalBuilder lets you do that.

...

  • Action Groups
  • Comment Actions
  • Action Comments
  • Variable Comments
  • Project Information Remarks

Action Groups

Action groups are the best way to describe the purpose of a sequence of actions. It's clear to the reader exactly which actions are covered by the comment, and you can collapse the action group and still see roughly what it's doing.

...

Comment actions are useful for providing further information about a part of your <%BUILDORPROJECT%>build. They draw the maintainer's attention to some important information about a part of the <%BUILDORPROJECT%>build. It's also good practice to place a comment at the start of each Target (apart from Main), describing the purpose of the Target and its parameters.

...