Home » Blog

XML documentation for your LightSpeed models

Tagged as LightSpeed

If you write your LightSpeed entities by hand, it’s easy to write XML documentation, so that users of your classes get helpful tooltips on the properties, methods and parameters. In LightSpeed 3, you can now create XML documentation in the designer.

To show or edit the XML documentation, just right-click anywhere in your model and choose Documentation. LightSpeed displays a Documentation window:

The Documentation window allows you to conveniently edit common documentation elements such as the Summary and Remarks. If you want to add less common documentation tags, such as <exception> or <example> elements, you can do so via the Additional box, but in this case you have to include the XML tags themselves:

As you move around the model, the Documentation window tracks the current selection, just like the Properties window does.

XML documentation isn’t yet available for all model elements, but it’s there for the most common ones: entities, entity properties, associations and stored procedures. If you’ve got a requirement for documentation on something that doesn’t support it yet, drop us a note in the forums and we’ll get it sorted for you.

Want to take it for a spin? Download the free Express edition today!

Add your comments
Posted by Ivan Towlson on 16 December 2009

One Response to “XML documentation for your LightSpeed models”

1. Didn’t even know about that. Thanks for the tip. I find I comment code less than ever these days. For an API, though, this is invaluable.

   Eric Swann Dec 22nd, 2009

Leave a Reply