I don't think I've ever seen a discussion of this, or seen anything in the documentation about this, but I'm sure that everyone on the forum is aware of this.

If you create a property in your project (either in a window or class or app), you can type some text in the code editor window, and it will be saved when you save your project, and magically reappear when you open it again. This would seem to be an ideal way to add a comment about the property. Except, as I mentioned above, I've never seen anything in the documentation to suggest doing this. So, I'm wondering, since it appears to be undocumented, is it safe to put comment text in the code editor window? If it is (or isn't), how many of you take advantage of this to document your properties?

Context:
Being somewhat hard of thinking, I probably overdocument my code, because I know that a week after I write something, I'll have no idea how it works unless there are two comments for every line of source code.

This is know and existsed in REALbasic / Real Studio.

Yes, usefull. Sometimes I even add where it is used (of course after I explain its meaning / use).

Same kind are the Notes.

It's not well-known, but you can also comment constants by using the usual '//' in the Default Value field in the Inspector.

@Julia T It's not well-known, but you can also comment constants by using the usual '//' in the Default Value field in the Inspector.

Julia... have you tried that?
If the varialbe is a STRING then its value is your "comment" (unless you immediately assign a new value)
if you change it to another datatype it removes your "comment" because it doesn't match the indicated datatype

Well, it works for numbers anyway.

I used to do it all the time in RS, but like so many other nice features, it may be compromised in Xojo.

@Robert W ...If you create a property in your project (either in a window or class or app), you can type some text in the code editor window, and it will be saved when you save your project, and magically reappear when you open it again. This would seem to be an ideal way to add a comment about the property. ...

Thanks for asking as I have had the same question. I remember that as a beginner, this large blank space seemed a bit imposing, as though inviting you to enter something. I also recall finding no mention in the documentation. I have been using it extensively for making notes and would find it irksome if it just went away on some future release.

Unless I’m mistaken about the lack of documentation, XOJO should include some for this feature.

As Rick A. mentioned, I also as a precaution made every line a commnent, but stopped the practice when I realized I could have auto-complete. (Why, again, can’t we have the option of auto-complete within a comment)?

Note that there is a “Description” field in the IDE inspector (showing one line, but supporting multi-lines) for properties, methods, constants, event handlers, etc. , usually/always located on the “gear tab” panel. It shows by default for Event Handlers which only have the ‘gear’ panel). The Description field may be a convenient place to keep notes, though it appears that the contents are not printed when one prints out code, whereas the bonus Properties area appears to be printed. Also, I suspect that most of us would want to have more that a single line visible by default.