【发布时间】:2010-09-21 21:07:46
【问题描述】:
我知道为IntelliSense 使用-vsdoc.js 文件,而用于jQuery 的文件很容易找到。还有哪些其他 JavaScript、Ajax 和 DHTML 库有它们,我在哪里可以找到这些文件?另外,是否有文档概述了 -vsdoc.js 文件的规范?
【问题讨论】:
我知道为IntelliSense 使用-vsdoc.js 文件,而用于jQuery 的文件很容易找到。还有哪些其他 JavaScript、Ajax 和 DHTML 库有它们,我在哪里可以找到这些文件?另外,是否有文档概述了 -vsdoc.js 文件的规范?
【问题讨论】:
来自 Betrand LeRoy 的一篇关于 JavaScript 的 IntelliSense 格式的优秀博客文章: The format for JavaScript doc comments.
简而言之:
摘要 - 用于描述函数/方法或事件。语法:
<summary locid="descriptionID">Description</summary>
Parameter - 描述函数/方法的参数。语法:
<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>
值类型 - 描述一个属性(不应该使用 'summary' 作为属性) - 语法:
<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>
Field - 用于描述 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>
如何为外部 JavaScript 文件包含 IntelliSense,以下语法作为 JavaScript 文件的第一行:
<reference path="path/to/the/script/reference.js"
assembly="Assembly.Name" name="ScriptResourceName.js"/>
【讨论】:
您可以在此处找到适用于 MooTools 的 Intellisense:http://code.google.com/p/mootoolsintellisense/downloads/list
【讨论】:
有人建立了一个非常好的vsdoc for Google Maps V3。我用它,效果很好。 ;-)
【讨论】:
我在文章中写了总结(通过调查)vsdoc 的哪些部分用于帮助 VS 2010 中的 Intellisense:http://www.scottlogic.co.uk/2010/08/vs-2010-vs-doc-and-javascript-intellisense/
【讨论】: