龙泉市旅游门户网站建设,114啦建站程序,icp备案网站信息查询,大数据查询介绍 作用 合作分享#xff1a;方便他人阅读#xff0c;便于分享 沉淀总结#xff1a;容易忘记代码#xff0c;自己总结沉淀 形式 1.// 双斜杠 2#xff0e;/**/斜杠星号 常用标签 标签 描述 module 标明当前文件模块#xff0c;在这个文件中的所有成员将被默认为属于… 介绍 作用 合作分享方便他人阅读便于分享 沉淀总结容易忘记代码自己总结沉淀 形式 1.// 双斜杠 2/**/斜杠星号 常用标签 标签 描述 module 标明当前文件模块在这个文件中的所有成员将被默认为属于此模块除非另外标明 submodule 针对模块的划分处于module之下 class 标示一个类或者一个函数 constructor 当使用对象字面量形式定义类时可使用此标签标明其构造函数 callback 标明此方法是一个回调函数 event 标明一个可触发的事件函数一个典型的事件是由对象定义的一组属性来表示。 constant 常量标识 member/var 记录一个基本数据类型的成员变量 method 标记一个方法或函数 param 标记方法参数及参数类型 property 标明一个对象的属性 readonly 只读 return 标明返回值、类型及描述 type 描述代码变量的类型 description 如果在注释开始描述可省略此标签 enum 一个类中属性的类型相同时使用此标签标明 example 示例代码可自动高亮 exports 标识此对象将会被导出到外部调用 ignore 忽略此注释块 link 内联标签创建一个链接如 {link http://github.com Github} name 指定一段代码的名称强制 JSDoc 使用此名称而不是代码里的名称 namespace 指定一个变量为命名空间变量 static 描述一个不需实例即可使用的变量 summary 对描述信息的短的概述 throws 描述方法将会出现的错误和异常 todo 描述函数的功能或任务 tutorial 插入一个指向向导教程的链接 更多标签可参考 http://yui.github.io/yuidoc/syntax/index.html http://usejsdoc.org/ 开发工具 sublimeDocBlockr /** Tab(回车)自动生成注释 在注释中回车自动生成 * 输入会自动提示标准注释的标签 文档输出 YUIDoc 不解析文本完全按照注释标签进行生成文档与代码分离 NodeJs环境 https://nodejs.org/download/ 下载node.js 安装YUIDoc npm install –g yuidocjs 使用 在相应的目录下输入 yuidoc . 会在当前目录生成 out文件里面生成注释文档 在相应的目录下输入 yuidoc . –server port会使用nodejs环境生成对应的网站 编写Js注释 l 以 /** 开头*/ 结束 l 按照层级格式编写 module,[sumodule], class,method,property等层级格式 l methodpropertyparam等必须在class下面 l 每个标签快里面只能包含下面一个标签描述了当前代码块的作用。 module 标签描述一组关联的类对对JS 没有类YUIDoc只是把有构造方法也归为类罢了。 class标签专门描述类的。在YUI库中通常是个构造函数。每个有class 标签的注释块都应该有一个static 或者 constructor的副标签。 method 描述类中的方法。你将会用到 return 和 params 副标签加以说明。 property 描述类中的属性 event 描述你自定义的可触发事件。YUIDoc文档里指出: 转载于:https://www.cnblogs.com/decode1234/p/11085003.html
