VS2010 : javascript intellisense : specifying properties for 'options' objects passed to methods

Posted by Master Morality on Stack Overflow See other posts from Stack Overflow or by Master Morality
Published on 2010-05-04T17:19:22Z Indexed on 2010/05/04 18:28 UTC
Read the original article Hit count: 301

Filed under:
|
|
|

Since javascript intellisense actually seems to work in VS2010, I thought I might add some to those scripts I include in almost everything.

The trouble is, on some complex functions, I use option objects instead of passing umpteen different parameters, like so:

function myFunc(options){
    var myVar1 = options.myVar1,
        myVar2 = options.myVar2,
        myVar3 = options.myVar3;
    ...
}

the trouble I am running into is, there doesn't seem to be a way to specify what properties options needs to have. I've tried this:

function myFunc(options){
    ///<summary>my func does stuff...</summary>
    ///<param name="options">
    ///myVar1 : the first var
    ///myVar2 : the second var
    ///myVar3 : the third var
    ///</param>

    var myVar1 = options.myVar1,
        myVar2 = options.myVar2,
        myVar3 = options.myVar3;
    ...
}

but the line breaks are removed and all the property comments run together, making them stupidly hard to read.

I've tried the <para> tags, but to no avail.

If anyone has any ideas on how I might achieve this, please let me know.

-Brandon

© Stack Overflow or respective owner

Related posts about VS2010

Related posts about JavaScript