2019-04-21

文档注释

各类标签@param, @method等请参考 JSDoc中文usejsdocJSDoc Guide

建议在以下情况下使用:

所有常量

所有函数

所有类

/**

* @func

* @desc 一个带参数的函数

* @param {string} a - 参数a

* @param {number} b=1 - 参数b默认值为1

* @param {string} c=1 - 参数c有两种支持的取值 1—表示x 2—表示xx

* @param {object} d - 参数d为一个对象

* @param {string} d.e - 参数d的e属性

* @param {string} d.f - 参数d的f属性

* @param {object[]} g - 参数g为一个对象数组

* @param {string} g.h - 参数g数组中一项的h属性

* @param {string} g.i - 参数g数组中一项的i属性

* @param {string} [j] - 参数j是一个可选参数

*/

function foo(a, b, c, d, g, j) { ... }
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • iOS应用架构谈 网络层设计方案 前言 网络层在一个App中也是一个不可缺少的部分,工程师们在网络层能够发挥的空间...
    iYeso阅读 2,828评论 0 0
  • 欢迎阅读旧物网服务条款协议(以下简称称“本协议”)。本协议阐述之条款和条件适用于您使用旧物网所提供的服务(以下简称...
    拂晓拂晓阅读 1,027评论 0 0
  • 隐秘时光 第一章 2 那时候最开心的事就是带表妹秀秀去华城百货买东西了。站在窗口,看到免费车来了就赶忙跑下去。到商...
    繁星谷阅读 2,732评论 0 0
  • 郑海燕焦点初十 中12坚持分享314天2019.4.21 事情没有绝对的因果论,当事人的解决之道也不见得必然会与任...
    晴岚85阅读 1,313评论 0 0
  • 很多现代人都患有严重的拖延症;也会是想的太多,我可以试着去学习一样新技能,还是明天开始我要开始健身等等但是最后还是...
    Nathandad大叔阅读 3,443评论 0 51