modelsbuilder / ModelsBuilder.Original

The Community Models Builder for Umbraco
MIT License
114 stars 49 forks source link

Intellisense <summary> not working in VS. #103

Open harvzor opened 8 years ago

harvzor commented 8 years ago

Hi, great work with this. I'm loving it so far.

It seems that the <summary> is generated for each property of a document type, and it uses the description that is entered in Umbraco. Though this isn't working for the Intellisense in Visual Studio.

Below is an image showing this:

summary

I'm using the "DLL" option for the "Umbraco.ModelsBuilder.ModelsMode".

Is there some way to get the Intellisense to work like it should?

zpqrtbnk commented 8 years ago

Turns out that /// <summary></summary> are not embedded with the Dll but should be in the associated Xml file, which we don't generate at the moment in Dll mode. The way to fix it is to generate the Xml file. Visual Studio does it (if you check the proper box), now I need to find how to get Roslyn to do it (since we compile the Dll with Roslyn).

zpqrtbnk commented 8 years ago

Note: probably want to look at Roslyn's CommonCompiler.cs to see how csc.exe generates the pdb and xml file.

And also: DocumentationCommentCompiler.cs

harvzor commented 7 years ago

For anyone else with this issue, I highly recommend following this blog post as it allows you to compile the models from a custom project rather than relying on the Models Builder to do it for you: https://www.dot-see.com/en/blog/how-to-use-modelsbuilder-in-a-multi-project-umbraco-solution/

This gives you more control and fixes the summaries.