随着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