Правила описания контекстной документации

Исходный код должен иметь контекстную документацию для каждого метода и свойства класса. Для документирования необходимо использовать нотацию VS XML Doc.

Документация для классов и событий

PP.Class1 = function()

{

    /// <summary> Summary description for Class1 </summary>

    /// <event name=’Click’> Summary description for Class1 </event>

    /// <property name=ImageUrl’ type=’String’> description </property>

}

Документация для свойств

getMyProperty = function()

{

    /// <summary> Documentation of property</summary>

    return this._MyProperty;

}

setMyProperty = function(value)

{

 ///<summary> Documentation goes on the getter</summary>

    this._MyProperty= value;

     }

Документация для методов

method = function(value)

{

  /// <summary> Documentation of method</summary>

  /// <param name="value" type="Number|String" optional="true"> описание параметра </param>

      /// <return type=’Number’> Описание возвращаемого значения </return>

}

Документация для интерфейсов

(PP.Exp.Ui.IEaxDocumentView = function ()

{

   /// <summary>IEaxDocumentView</summary>

   /// <event name="ActiveSheetChanged">Описание события</event>

   /// <property name="DataView" type="IExpressDataView"></property>

   /// <method name="ModeSelectorView" type="IEaxModeSelectorView"></method>

   var intf = PP.Exp.Ui.IEaxDocumentView;

   PP.initInterface(intf, "IEaxDocumentView", PP.IDataView);

   intf.DataView = intf.ModeSelectorView = PP.ClassMembers.Property;

   intf.ActiveSheetChanged = PP.ClassMembers.Event;

})();

Документация для перечислений

(PP.Ui.Visibility = function ()

{

   /// <summary> Видимость объекта (видимый, невидимый) </summary>

   /// <field name="Collapsed" type="String">Скрывает какdisplay:none</field>

   /// <field name="Visible" type="String">Видимый</field>

   /// <field name="Hidden" type="String">Скрывает как visibility:hidden</field>

   var t = PP.Ui.Visibility;

   t.Collapsed = "Collapsed";

   t.Visible = "Visible";

   t.Hidden = "Hidden";

   PP.initEnum(t, "Visibility");

})();

Устаревшие члены следует помечать флагом obsolete

<property name="DataView" type="IexpressDataView" obsolete></property>

См. также:

Спецификация разработки на javaScript