2022年 12月
 1234
567891011
12131415161718
19202122232425
262728293031  

近期发布

近期评论

    2022 年 12 月 2 日

    Neusofts

    科技改变生活,创新引领未来

    前端文档生成利器——Jsduck

    jsduck是senchalabs众多开源项目中的一个,它是使用ruby 编写的javascript API文档生成器。

    Jsduck强力功能点如下:

    • 树形类命名空间组织
    • 类子父关系的层次体系展示
    • 成员与事件和配置项快速索引
    • 可穿插着色代码范例演示和编辑范例代码
    • 类成员源码实现部分快速导航

     

    以下是一些常用标签的注解:

    • @author:作者
    • @class:类
    • @deprecated:标记此方法属性或者类不赞成使用,在升级过渡的时候需兼容之前的API时特别有用。
    • @example:给类或者方法添加一个代码范例,jsduck不仅会给代码着色,还能给代码生成一个代码编辑器,编辑代码后可实时预览,使用@example需要四个空格的缩进。
    • @extends:标记一个类继承自另一个类,生成后会有一个类型继承体系陈列在文档视图的右侧。
    • @cfg:构造器的配置项,并在其后跟随“{className}”,再跟随参数名。
    • 范例:@cfg {String} fieldName配置项的描述。
    • @return:与@cfg类似,标记一个函数成员调用过后的返回类型。
    • 范例:@return {Number} 文字描述
    • @param:与@cfg类似,给一个函数成员标记其所需的参数类型和描述,如果参数类型为多种可以用“/”分割,如需要给参数进行更详细描述还能使用“[param.member]”描述符。
    • 范例:@param {Number/String} fieldName
    • 范例:@param {String[]} fieldName
    • 范例: 
      /**
      * @cfg {Object} opt
      * @cfg {Number} [opt.age]
      * @cfg {Number} [opt.name=0]
      */
    • @event:标记一个事件,随后通常会跟随@param标签给事件回调函数声明参数的说明。
    • @inheritdoc:在其后跟随Class#member,常用在子类覆盖父类成员后,子类注释块还需继续使用父类注释的情况下使用。
    • @private:将成员标记成私有,虽然也有@public但如果不特殊标明即为公有。
    • @protected:将成员标记成受保护的。
    • @static:将成员标记成静态的,静态成员也会在文档中进行分类展示。
    • @img:在文档注释中链接一张图片,让文档变得更具可读性。
    • @link:在文档注释中标记某个类或类成员的锚点。

    文档化你的项目不仅可以让催悲的前端们将自己写的注释变更具有价值,也可以为项目后期维护带来巨大便捷,在协同作战环境下起着至关重要的作用。

     

    参考资料:http://lzw.me/Category/website/jsduck-doc.html