27 November 2008 | Team Tamar

jQuery Intellisense for VS 2008

has released new intellisense support for the Visual Studio family. This is now
available to download and use on Visual Studio 2008 and Visual Web Developer
2008 Express (which is free).


Steps to Enable jQuery Intellisense
in VS 2008


To enable
intellisense completion for jQuery within VS you'll want to follow three steps:


Step 1: Install VS 2008 SP1


VS 2008 SP1
adds richer JavaScript intellisense support to Visual Studio, and adds code
completion support for a broad range of JavaScript libraries.

You can
download VS 2008 SP1 and Visual Web Developer 2008 Express SP1 here.


Step 2: Install VS 2008 Patch
KB958502 to Support "-vsdoc.js" Intellisense Files


annotated "-vsdoc.js" files can include XML comments that provide
help documentation for JavaScript methods, as well as additional code
intellisense hints for dynamic JavaScript signatures that cannot automatically
be inferred.  You can learn more about
this patch here.  You can download it for free here.


Step 3: Download the jQuery-vsdoc.js

You can
download both jQuery and the jQuery-vsdoc file from the official download
on the jQuery.com site.


Save the
jquery-vsdoc.js file next to your jquery.js file in your project (and make sure
its naming prefix matches the jquery file name)


You can
then reference the standard jquery file with an html <script/>

alternatively reference it using the <asp:scriptmanager/>
control, or by adding a /// <reference/>
comment at the top of a standalone .js file. 


When you do
this VS will now look for a -vsdoc.js file in the same directory as the script
file you are referencing, and if found will use it for help and intellisense.

example, we could use jQuery to make a JSON based get request, and get
intellisense for the method (hanging off of $.).


intellisense will continue to work if you nest a callback function within the
method call.  For example, we might want
to iterate over each JSON object returned from the server:


JavaScript Intellisense Tips and

Rick Strahl
also has a good post about using jQuery intellisense here.


Team Tamar