2008-11-11 37 views

回答

13

從伯特蘭萊羅伊一個優秀博客張貼在智能感知格式爲JavaScript: The format for JavaScript doc comments

簡而言之:

摘要 - 用於描述功能/方法或事件。語法:

<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文件中,t他下面的語法爲JavaScript文件的第一行(S):

<reference path="path/to/the/script/reference.js" 
    assembly="Assembly.Name" name="ScriptResourceName.js"/> 
相關問題