A comment about comments in dynaSight

Technically speaking, if you do not comment your programming in dynaSight your applications will run and if you have been attentive in your development work, they will probably even run well.

Or at least that is the view of many developers...

This until, of course, someone starts working with you on a project or you are asked to change something you implemented in a rush three months ago. At this point, the lack of documentation in the dynaSight documents will come back to haunt you.

Graphical development environments such as dynaSight have many perks: rapid progress and results are just two of those. One disadvantage is that due to the lack of a unique source code, you have a series of objects each of which are created, in part graphically, and in part through the dynaSight script language. Each object in turn has their own series of events and triggers, behind each of which a complex script may be hiding.

To avoid problems in such cases is quite simple. Document your work by using text objects in non-visible document levels and even color-code the documents and cells that do the work in the background. In text fields, explain what is being done and how by making explicit reference to the object numbers in question.

Once you get into the habit of doing this, you will find yourself not just doing so automatically, but also you will automatically start looking for your own past comments and the comments of other devlopers, as you look for guidance in making modifications to existing applications.

previous tip | next tip