谈谈JSDOC对ES6的支持

本文探讨了在前端开发中,随着ES6和babel的普及,如何使用JSDOC为ES6模块生成高质量文档。文章指出在ES6编译前生成文档更具优势,并强调了模块与命名空间的区别。通过示例解释了如何使用@namespace注解来正确记录模块导出的对象。总结了在充分理解模块系统基础上,利用JSDOC创建详细文档的方法。
摘要由CSDN通过智能技术生成

随着AMD与COMMONJS的深入人心,ES6与babel的组合已成为前端开发必备套件,所以也有必要更新JSDOC的写法,为应用与技术的发展与维护提高更好的文档支持。

1. 生成文档的两种选择

根据前端代码编译的生命周期,生成文档可以选择在ES6编译后或ES6编译前,编译后的优点是能完全兼容ES3文档规范,学习成本低,所需的JSDOC注解较少,但经过测试,却发现可信度不高,原因在于编译后代码与注释的关联性太低,甚至出现了注释丢失的现象。

所以,本文主要讨论ES6编译前的文档生成方法。

2. 对于模块的理解

在JSDOC中,模块只是一个组合,是对类、方法、常量的一个集合,那么问题来了,如果模块一个组合,那么它就不能作为一个对象对待,不能拥有自身的属性与方法。

需要特别注意的是,模块与命名空间是两个不同的概念,模块只是虚拟的占位符,而命名空间这是一个具体的对象。

3. 从模块中导出对象的JSDOC

/**
 * StiStrap module
 * @module StiStrap
 * @namespace StiStrap
 * @desc 提供Bootstrap的Vue实现
 */
export const StiStrap = {

    /**
     * @see St
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值