A VSDoc for jQuery 1.5
JavaScript, jQuery By Dave Ward. Updated February 5, 2011
I’ve noticed several people looking for a jQuery 1.5 VSDoc this week. After looking around myself, I didn’t see one anywhere either. So, I updated Damian Edwards’ VsDocBuilder for jQuery 1.5 and generated a new VSDoc.
It doesn’t handle the new jqXHR and Deferred return types quite right, so you won’t get Intellisense for the new chained $.ajax() callbacks. However, it should be better than nothing until a fully functioning version is released.
You can download it here: jQuery-1.5.0-vsdoc.js
Update: Damian has just made a fully functional version of the 1.5 VSDoc available (that was quick): jquery-1.5-vsdoc.js. You should use his instead of mine.
Important: This new VSDoc makes use of <para> tags to display line breaks inside documentation tooltips. To view them properly, you’ll need to be sure that you have the JScript Editor Extensions installed so that Visual Studio understands those new VSDoc tags.
Similar posts
What do you think?
I appreciate all of your comments, but please try to stay on topic. If you have a question unrelated to this post, I recommend posting on the ASP.NET forums or Stack Overflow instead.
If you're replying to another comment, use the threading feature by clicking "Reply to this comment" before submitting your own.
Thanks for putting this together! I’m afraid I get a 404 – not found error when trying to download from: http://encosia.com/source/jquery/jquery-1.5.0-vsdoc.js
Sorry about that; caching issue. It should be available now.
Thanks Dave. I’m in the middle of updating the tool to properly support 1.5 now. As you mention, the issue I’m having is adding support for the new jqXHR object, as it has no prototype or structured spec in the API documentation I can’t auto-generate it from that. I’m experimenting with different ways of generating the vsdoc for that entry to get good IntelliSense in VS when using $.ajax().
Thanks for posting. Very useful.
This will save my time. Thank you Dave.
Very nice, gotta have my Intellisense.
I’ve found the vsdoc files to be very unreliable and constantly outdated so I’ve given up on them for now. (MS doesn’t help much as you need to install hotfixes for VS2008 to get them to work). I also found my pages would get javascript errors when using some of the vsdoc files like 1.5. My understanding is that jQuery intellisense still won’t work correctly in VS if you use a minimized version of the javascript libraries. You have to use the “source code” version of the libraries. Is this correct?
Thanks.
If you’re using the vsdoc, you’ll get full Intellisense even when referencing the minified version of jQuery. If you don’t have a vsdoc in place and are referencing jQuery.min, then you will see the cryptic $(a, b, c) type Intellisense.
Personally, I don’t use Intellisense in JavaScript most of the time. It’s a small enough language (and jQuery is a small enough API) that code completion often just gets in the way, or is misleading due to dynamic typing.
Thanks. I agree that intellisense gets in the way sometimes.
to install jquery and the intellisense docs, do the following (done in 60 seconds or less)
in Visual Studio 2010, go to:
tools > Library package manager > Package manager console
wait a few seconds till you see “PM >”
then type:
Install-Package jQuery (enter)
once that’s installed, at the next “PM >” type:
Install-Package jQuery.vsdoc (enter)
Note1: It will install the latest version automagically (currently 1.6)
Note2: it’s smart enought to uninstall previous versions (eg 1.5.2)
Pat yourself on the back for a job well done!
Microsoft has a vsdoc version on cdn for every version of jQuery. See the list of links here: http://www.asp.net/ajaxlibrary/cdn.ashx