Configurable location of xml annotations

Hi, code annotations are nice, but there's a limitation with third party libraries since the only way to annotate them is to use xml and place it in the R# installation directory. It would be useful if R# was able to pick them up from a project or output folder to make it self-contained. Is this something already achievable in any ways?

9 comments
Comment actions Permalink

You can put external annotations side-by-side with dll.

Sincerely,
Ilya Ryzhenkov

JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"


IR> Hi, code annotations are nice, but there's a limitation with third
IR> party libraries since the only way to annotate them is to use xml
IR> and place it in the R# installation directory. It would be useful if
IR> R# was able to pick them up from a project or output folder to make
IR> it self-contained. Is this something already achievable in any ways?
IR>
IR> ---
IR> Original message URL:
IR> http://www.jetbrains.net/devnet/message/5260369#5260369


0
Comment actions Permalink

I cannot get it to work. For example, I annotated Jayrock and when I put the xml in the ExternalAnnotations folder it works fine, while placing it in either root directory, bin directory or next to where I reference Jayrock.dll from in my web app referencing Jayrock.dll it does not have any effect.

0
Comment actions Permalink

During the external annotations lookup, the co-location with the DLL is the top priority.
Please note that ReSharper scans them on startup, so after moving the file VS should be re-started

0
Comment actions Permalink

So, to make it clear, if I have an ASP.NET web application using Jayrock.dll from the bin directory, where should my Jayrock.xml file containing annotations go?

0
Comment actions Permalink

In the bin directory too


0
Comment actions Permalink

Ok, tried it, it doesn't work. If I copy the same Jayrock.xml file in the ExternalAnnotations folder in the R# installation directory and restart VS then it works.

0
Comment actions Permalink

Thank you for the feedback.
I'll check this issue.

http://youtrack.jetbrains.net/issue/RSRP-177643

0
Comment actions Permalink

Thanks, for any additional details and tentatives to try feel free to ask, I'll be watching the issue.

0
Comment actions Permalink

I've checked the code. The co-located external annotations file has special naming convention - it should end with ".ExternalAnnotations.xml"

So if your assembly is a.dll, then ext.ann. file should be a.ExternalAnnotations.xml (to not to clash with xml-doc)

Sorry for inconvinience

0

Please sign in to leave a comment.