Возвращает элемент для Javascript vsdocs

Question

Я работаю над довольно тяжелым клиентским JavaScript-приложением и собираюсь добавить документацию. Я использовал стиль vsdoc, чтобы использовать intellisense, но у меня возникают проблемы с определением возвращаемых объектов.

Предполагая функцию, определенную как:

function returnObject() {
    return { 'prop1': 'value1', method: function(){return 1;}};
}

Я хотел бы иметь возможность написать код как:

returnObject (). и после. см. "prop1" и "method" в intellisense - возможно ли это без определения объекта в другом месте?

Как бы я определил возвращаемый объект? Я смотрел на документацию здесь, но пока это мало помогало. Просмотр jQuery vsdoc показывает, что они почти всегда возвращают объект jQuery или простой тип. Глядя на amps vsdoc показывает, что они возвращают Object или undefined, а затем объясняют, как этот объект выглядит в тексте.

Могу ли я использовать документацию стиля элемента ///, чтобы определить, как будет выглядеть возвращаемый объект? У кого-нибудь есть образец этого?

Answer 1

Вам не нужен файл VSDOC для этого сценария в Visual Studio 2012+.

Vsdoc полезен в ситуациях, когда внутренний интерпретатор javascript не может выполнить код, например, веб-сервисы.

Файлы vsdoc также полезны, когда в коде используются комментарии в стиле jsdoc, и вы не хотите иметь два формата комментариев в основных файлах кода. Jquery является хорошим примером этого.

Также обратите внимание, что файлы vsdoc теперь называются файлами intellisense. Однако концепция все та же.

Использование встроенных комментариев: