That is usually good for users to understand something about "What's going on?".
But it also slows down the build process:
Every line in a Run or Exec section is processed.
When the line is a comment, nothing happens due to the target, but:
- The line is read and parsed
- Maybe an entry into the log is made
Suggestion:
- When releasing a new API version, remove all comments which make test lines inactive.
- Remove syntax explanations / samples at the beginning of the function.
Here a way to preserve them.
Sample:
[My-Function] //Line to explain something //Line to explain something //Line to explain something //Line to explain something FileCopy, ... If, ...Change to
[Comment_1] //Line to explain something //Line to explain something //Line to explain something //Line to explain something [My-Function] FileCopy, ... If, ...So the [Comment_1] lines are never processed by the WinBuilder script engine.
Multiple (unused) [Comment_?] sections are no problem.
Peter