常用的jsDoc

Javascript属于无类型的语言，这对于开发者入门很方便。但对于框架的开发者和IDE的开发者，缺少类型描述有很多不便。其实利用JSDoc稍作扩展，我们可以把它用于类型和值域定义，进而用于代码提示和语法分析。 这样框架的使用者可以在IDE里方便的使用代码提示和语法错误分析功能。下面介绍几个 常用的jsDoc。

    //使用@alias可以给一个变量或者函数指定一个别名，代码提示时会提示该别名
    @alias aliasName 

    //使用@constructor可以标识一个函数是构造函数
    @constructor    

    //使用@description可以在代码提示时显示被描述变量或者函数的描述信息。
    @description 描述内容 

    //使用@example可以提示代码示例
    @example 示例内容

    //使用@extends用于标识继承于某个类型  
    @extends {Type}  

    //使用@param可以描述一个函数的参数以及参数类型，HBuilder扩展了参数值域的写法（目前只支持字符串值域）
    @param {Type[,Type,...]} ParameterName=[Value1|Value2[|Value3|...]] 参数描述   

    //使用@property可以描述一个对象的属性
    @property {Type[,Type,...]} propertyName 属性描述   

    //使用@return可以描述一个对象的属性
    @return {Type[,Type,...]} 

    //使用@type可以定义某个变量的类型
    @type {Type[,Type,...]}