KarlZ

HEADLINE: If I use the Entity Framework (Self Tracking Entities or EntityObjects) templates, how can I add XML Comments so that I can use Sandcastle and Sandcastle Help File Builder to generate the documentation for my libraries? Is there a way to modify the T4 templates so that I can access the property documentation? (The answer is yes)

This uses Microsoft Visual Studio 2010 Beta 2, Microsoft ADO.NET Entity Framework (EF) Feature Community Technology Preview 2, Sandcastle, and Sandcastle Help File Builder (SHFB)

Details:

If I turn on XML Documentation:

Then a comment like this:

Will be output into the .xml file.

I tried putting documentation into the Model. Here is the designer view:

However, these never seem to be output as the publicly visible comments (///) in the generated code.

To do that, add this in the template immediately above the property:

After doing this I got the following in my Book.auto.cs class:

Then my documentation can look like this:

The above was created using Sandcastle and the Sandcastle Help File Builder.