Visual Studio 2008 doesn't show my XML comments in JS files.

Question

function Submit_click()
{
  if (!bValidateFields())
    return;
}

function bValidateFields() {
/// <summary>Validation rules</summary>
/// <returns>Boolean</returns>
...
}

So, when I type the call to my bValidateFields() function intellisence in Visual Studio doesn't show my comments. But according to this it should. Should it?

Answer 1

Did you try adding the /// <reference> comment at the top of the external library? I've run into this in the past and it resolved my issue.

Answer 2

I recall an issue where having turned off the Navigation Bar in VS stopped a lot of the JS intellisense from working properly. If you have it turned off, try turning the Navigation Bar on again and see if it helps.

Edit: You may also have to do Ctrl+Shift+J to force the IDE to update the intellisense.

Edit2: As @blub said, if there are any issues with the javascript, the intellisense can break. Visual Studio actually evaluates the javascript to create the intellisense, so if there are syntax errors it can fail and not build the intellisense completely, or at all.

Answer 3

The XML comments have to be inside the function, not above it. In Visual Studio 2008, the XML comment information is only display for files referenced with a /// <reference... item.

Visual Studio 2010 will display XML comment information for functions in the file your are editing and for files you are referencing.