Documenting a Property

General
1

When using the Xojo IDE and doing something like creating a Property the Window is divided into a left, middle, and right area. The right area is where you specify the Name and Type of the new Property. The left area shows where the new Property lives among its compatriots. The middle area is “unused”. It accepts plain text.

It seems to invite putting a comment about the new Property for your own reference. Is this a safe, suitable thing to do? Do others use it for this purpose? Are there better uses for this space? Should I just leave it blank and not rely on it for anything? I am curious about what more (or less) experienced Xojo developers do.

2

I use this area for comments all the time. It works just like a project “Note” item, but is attached to the property instead of being its own item in the Navigator(left side). I wish all Navigator-level project items had a little note area like this.

2 Likes
3

Yes. That’s what it’s for.