保存
×

代码的注释其实是比较重要又容易被忽视的环节,正好最近接手的项目可能需要进行重构,于是决定从注释开始,采用 JSDOC 来完善注释。

关于 @module 和 @exports

module 和 exports 都用于对模块进行注释,两者的区别就是:

针对模块的注释

http://usejsdoc.org/howto-commonjs-modules.html

CommonJS Module (node)

在文件顶部使用@module 标记,jsdoc 会自动识别挂载到 exports 对象上去的属性,包括module.exports =exports =两种方式。

注释 AMD 模块(requirejs)

  1. 使用 @exports 注明返回的对象
  2. 在第一行使用 @module 注明模块名字 xxx,然后再在返回的对象上使用 @alias module:xxx

一些注意事项

主要参考的是 Gooogle javascript code style

Google 不推荐使用下列的 tag:

PS: A list of every tag