This thread looks to be a little on the old side and therefore may no longer be relevant. Please see if there is a newer thread on the subject and ensure you're using the most recent build of any software if your question regards a particular product.
This thread has been locked and is no longer accepting new posts, if you have a question regarding this topic please email us at support@mindscape.co.nz
|
Please correct me if i am wrong, but as far as i can tell the lightspeed designer doesn't have any way of adding custom descriptions to your entities, and properties.
This would be an awesome feature, for fairly obvious reasons.
If its not already in there, can you add it to the wishlist :D
|
|
|
The current nightly builds support XML documentation comments for entities, properties and associations. Not quite the same as general comments, but useful all the same! If this is what you're after, and you don't have the current nightly, you can get it from http://www.mindscape.co.nz/products/lightspeed/nightlybuilds.aspx or the store (please note the warning about manually uninstalling before upgrading from 2.2 RTM). If you're talking about more general (non-documentation) comments, we'd be interested to hear what you'd be looking for. Just a general "Comments" field that would appear in the properties window? Or something that would actually appear on the design surface itself? That would be more useful, but there's the danger of clutter... Anyway, feedback welcome. |
|
|
Forgot to say... if XML doc comments are what you're after, then in the nightly build, right-click and choose Documentation to see or edit them. (They're not in the properties window because those tiny cells aren't very convenient for editing documentation-sized blocks of text.) |
|
|
Sorry for "opening" this old post, but how about adding a visual indicator to the entities in the designer that contains such documentation? This would make the documentation even more usefull :)
|
|
|
Hi Thomas, Could you say a bit more about what sort of thing you'd like to see? You can leave the Documentation window open to see the documentation as the selection changes. Or are you looking for some kind of indicator of "this does / doesn't have documentation" so you can see where you still need to write the docs (or what it's worth opening the docs window for)? |
|
|
I was thinking about an indicator to show if something has got documentation or not, yes. And, as you point out, this will give you two things:
|
|