IntelliSense для библиотек Ajax и JavaScript в Visual Studio
Я знаю об использовании файла -vsdoc.js для IntelliSense, и его легко найти. Какие еще библиотеки JavaScript, Ajax и DHTML имеют их и где я могу найти эти файлы? Кроме того, есть ли документ, в котором изложены спецификации для файлов -vsdoc.js?
4 ответа
Отличная запись в блоге от Betrand LeRoy о формате IntelliSense для JavaScript: формат комментариев к документам JavaScript.
В двух словах:
Сводка - используется для описания функции / метода или события. Синтаксис:
<summary locid="descriptionID">Description</summary>
Параметр - опишите параметр функции / метода. Синтаксис:
<param name="parameterName"
mayBeNull="true|false" optional="true|false"
type="ParameterType" parameterArray="true|false"
integer="true|false" domElement="true|false"
elementType="ArrayElementType" elementInteger="true|false"
elementDomElement="true|false"
elementMayBeNull="true|false">Description</param>
Тег param используется для описания параметров метода или конструктора. Теги param должны быть в том же порядке, что и параметры метода или конструктора, и иметь те же имена.
Тип возврата функции - синтаксис:
<returns
type="ValueType" integer="true|false" domElement="true|false"
mayBeNull="true|false" elementType="ArrayElementType"
elementInteger="true|false" elementDomElement="true|false"
elementMayBeNull="true|false">Description</returns>
Тип значения - описывает свойство (не следует использовать "резюме" для реквизита) - синтаксис:
<value
type="ValueType" integer="true|false" domElement="true|false"
mayBeNull="true|false" elementType="ArrayElementType"
elementInteger="true|false" elementDomElement="true|false"
elementMayBeNull="true|false"
locid="descriptionID">Description</value>
Поле - используется для описания поля в классе JavaScript - синтаксис:
<field name="fieldName" type="FieldType"
integer="true|false" domElement="true|false" mayBeNull="true|false"
elementType="ArrayElementType" elementInteger="true|false"
elementDomElement="true|false" elementMayBeNull="true|false"
locid="descriptionID">Description</field>
Как включить IntelliSense для внешнего файла JavaScript, следующий синтаксис в качестве первой строки в файле JavaScript:
<reference path="path/to/the/script/reference.js"
assembly="Assembly.Name" name="ScriptResourceName.js"/>
Я написал в статье, чтобы подвести итог (из исследования), какие части vsdoc используются, чтобы помочь Intellisense в VS 2010: http://www.scottlogic.co.uk/2010/08/vs-2010-vs-doc-and-javascript-intellisense/
Какой-то парень создал очень хороший vsdoc для Google Maps V3. Я использую это, это работает хорошо.;-)
Вы можете найти Intellisense для MooTools здесь: http://code.google.com/p/mootoolsintellisense/downloads/list