Visual Studio and XML Commenting in Javascript makes "public" methods disappear in intellisense

Question

I was elated to find out that I could use XML commenting in my javascript (i.e.):

/// <summary>Determines the area of a circle based on a radius parameter.</summary>
/// <param name="Name" type="String">Give this dude a NAME!</param>
/// <returns type="Nothing">The area.</returns>

That was until I realized that after I did this, my "public" methods were no longer listed in intellisense... :-(

 this.greet = function (greeting) {
        alert(greeting + " " + this);
    }

The above would show up when I would instantiate var thePlayer = new player('bob'); ... thePlayer. <-- greet would be listed, UNTIL I threw in the above XML comments.

Does anyone have any experience with this and a work around? Being able to comment javascript into intellisense would be very nice!

Did you try commenting with *'s or just using two dashes instead of three/ — Larry Battle
– Larry Battle, Commented Apr 30, 2012 at 2:08
I added the asterisks HERE so the summary, param and returns tags would show up. These are the three that MS uses for the commenting. Also, 3 slashes so that VS would see that I am attempting XML commenting. — Todd Vance
– Todd Vance, Commented Apr 30, 2012 at 2:17
I'm assuming you only added the asterisks because you hadn't indented the comments (thus getting syntax highlighting) -- my edit should fix this — drzaus
– drzaus, Commented May 16, 2013 at 19:29

Bryan · Accepted Answer · 2012-04-30 19:28:31Z

1

I think if you remove the (type="Nothing") from the returns it should show the members on a player.

answered Apr 30, 2012 at 19:28

Bryan

261 bronze badge

Sign up to request clarification or add additional context in comments.

1 Comment

Todd Vance Over a year ago

That's it! Thanks a ton! This is NOW cool again! Guess you can BREAK stuff even using XML commenting. Thanks!

Collectives™ on Stack Overflow

Visual Studio and XML Commenting in Javascript makes "public" methods disappear in intellisense

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related