Comments on: XML Comments for Entity Framework

By: karlz

karlz — Fri, 04 May 2012 03:51:03 +0000

The only thing that comes to mind then are: 1) Are you using Visual Studio 10, and 2) Did you put the comments into the Model?
By comments in the model I’m talking about opening the .edmx in the designer view and the selecting the field in question and going to the properties tab and filling out the two Documentation fields (Summary and Long Description) for the field in question. Save the .edmx and then

I’m actually in the middle of another project that uses the Entity Framework. I wanted to do this, but hadn’t gottne to it yet. I just tried and it seems a bit tricky. One time I select “Run Custom Tool” and it did nothing. Moments later I got the message, “The file has changed on disk, do you want to reload?” And there was my comment!

By: George

George — Fri, 04 May 2012 01:58:12 +0000

Thanks for the reply Karlz! I found some similar code in the DbContext model template and gave it a try. I didn’t get any errors or warnings but the comments still don’t show up. I even tried editing the CS file and re-running the template just to make sure it was actually regenerating the code. So far, no luck but I’m determined to get this working.

I’ll have to do some extra reading. I was hoping to learn as little as possible about these templates but it looks like I may need to dig a little deeper. I’m probably missing the obvious due to my lack of knowledge in this area. I’ll keep plugging away.

Thanks again for blogging about this. I still have hope!

By: karlz

karlz — Thu, 03 May 2012 11:37:55 +0000

I’ve downloaded the template but I’ve not worked with it yet.
In the Self Tracking Entity template there is a section that starts with:
region.Begin(“Primitieve Properties”);
foreaeach (EdmProperty …)
{

[DataMember]

Is there not something like that in the DbContext T4 template?

By: George

George — Thu, 03 May 2012 02:04:25 +0000

I’m trying to do this with the DbContext template. Any tips on where to place the above code snippet? The article says to add the code immediately above ‘the property’. So far I’ve been ridiculously unsuccessful modifying my template.

Has anyone else working with DbContext T4 templates got this working?