1

javascript intellisense は実際には VS2010 で動作するように見えるので、ほとんどすべてに含めるスクリプトにいくつか追加する可能性があると考えました。

問題は、一部の複雑な関数では、次のように多数の異なるパラメーターを渡す代わりにオプション オブジェクトを使用することです。

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>がダメでした。

どうすればこれを達成できるかについて誰かがアイデアを持っている場合は、お知らせください。

-ブランドン

4

3 に答える 3

2

次の構文を使用して改行を強制できます。

/// <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>
于 2011-07-28T21:02:15.070 に答える
1

MicrosoftのJScriptEditorExtensionsを使用:http://visualstudiogallery.msdn.microsoft.com/872d27ee-38c7-4a97-98dc-0d8a431cc2ed

<para>タグがサポートされるようになりました

于 2011-07-29T23:03:54.373 に答える
0

jQuery の vsdoc ファイルはそのアプローチを使用しています。すべてが 1 行に収まっている場合でも、ある程度読みやすいように、フォーマットを試してみる必要があります。たとえば、jQuery 1.4.1 の vsdoc ファイルからの抜粋を次に示します。

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" );

};

結果として得られるツールチップではすべてが 1 行に表示されますが、各項目の構造のおかげで (特に各項目の末尾に「.」があるため)、かなり読みやすいです。

于 2010-05-04T18:12:25.220 に答える