В Javascript, где я могу поместить XML-комментарий к var, чтобы он отображался в intellisense?
Я успешно использую intellisense в своем коде javascript для функций, но я не знаю, как заставить его работать для переменной или нужно ли разрабатывать этот класс по-другому, чтобы эффективно его документировать.
(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);
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;