1

関数の JavaScript コードでインテリセンスを正常に使用していますが、それを var で機能させる方法や、効果的に文書化できるようにこのクラスを別の方法で設計する必要があるかどうかはわかりません。 

(function ($)
{
  $.myNamespace.MyClass = {

    m_varIWantToCommentOn: null,
    /// <summary locid="m_varIWantToCommentOn">
    ///     *This doesn't work here*  How should I comment on what this var is for?
    /// </summary>

    Init: function ()
    {
        /// <summary locid="Init">
        /// Called when MyClass is initialized for the first time.  this comment works fine.
        /// </summary>
        // ...use m_varIWantToCommentOn in some way...
    }
  }
})(jQuery);
4

1 に答える 1

1

この質問はちょっと古いことは知っていますが、他の誰かが同じ質問をしている場合に備えて...

<field>タグを使用させていただきます。内部にある関数のドキュメントとは異なり、説明するフィールドの上にあります。

    (function ($) {
    $.myNamespace.MyClass = {

        /// <field> comments here </field>
        m_varIWantToCommentOn: null,

        Init: function () {
            /// <summary locid="Init">
            /// Called when MyClass is initialized for the first time.  this comment works fine.
            /// </summary>
            // ...use m_varIWantToCommentOn in some way...


        }
    }
})(jQuery);

通常、<var>タグは var 宣言でのみ使用されますが、タグが記述する var の上にも使用されます。

/// <var>comments here</var>
var someVar = null,
/// <var>This is a number</var>
anotherVar = 0;
于 2012-11-27T22:11:45.237 に答える