代码之家 › 专栏 › 技术社区 › Master Morality

VS2010:javascript intellisense:指定传递给方法的“options”对象的属性

vsdoc intellisense visual-studio-2010 javascript

1

Master Morality · 技术社区 · 15 年前

因为javascript intellisense实际上似乎在VS2010中工作,所以我想我可以在几乎所有的脚本中添加一些。

问题是,在一些复杂的函数中,我使用option对象,而不是传递许多不同的参数,例如:

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

options 必须有。我试过这个:

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;
    ...
}

但换行符被删除,所有属性注释一起运行,这使得它们很难阅读。

<para> 标签,但没用。

如果有人对我如何做到这一点有任何想法,请告诉我。

-布兰登

3 回复 | 直到 15 年前

1

2

Christopher 14 年前

可以使用以下语法强制换行:

/// <summary>
///   My method description  
/// </summary>
/// <param name="options" type="Object">
///     A JSON Object
///     &#10;1 - prop1: name
///     &#10;2 - prop2: id
///     &#10;3 - onSuccess: function to exec
/// </param>

2

1

anthony sottile 14 年前

使用Microsoft的JScript编辑器扩展: http://visualstudiogallery.msdn.microsoft.com/872d27ee-38c7-4a97-98dc-0d8a431cc2ed

<para> 现在支持标记

3

0

InfinitiesLoop 15 年前

jQuery的vsdoc文件使用这种方法。你只需要尝试格式化它,这样即使它都在一行上,它也能读一些。例如,以下是jQuery 1.4.1vsdoc文件的摘录:

jQuery.fn[ "blur" ] = function( fn ) {
/// <summary>
///     1: blur() - Triggers the blur event of each matched element.
///     2: blur(fn) - Binds a function to the blur event of each matched element.
/// </summary>
/// <param name="fn" type="Function">The function to execute.</param>
/// <returns type="jQuery" />

return fn ? this.bind( "blur", fn ) : this.trigger( "blur" );

生成的工具提示确实将其全部放在一行上,但由于每个项的结构(特别是因为每个项的末尾都有一个“.”),它仍然相当可读。