介绍功能合作分享:方便别人阅读,方便分享沉淀总结:容易忘记代码,总结沉淀形式//双斜杠/**/斜杠星号常用标签标签描述@module1表示当前文件Module,这个文件中的所有成员都会默认属于这个模块,除非另外标明@submodule1为模块的划分,在@module下@class标示一个类或一个函数@constructor形式定义时对象字面量的类,可以用这个标签来表示构造函数@callback表示这个方法是一个回调函数@event表示一个可触发的事件函数,一个典型的事件是由对象定义的一组属性来标记的。@constant常量标识@member/@var记录一个基本数据类型的成员变量@method标记方法或函数@param标记方法参数和参数类型@property标记对象属性@readonly只读@return标记返回值,type和Description@type描述代码变量的类型@description如果description在注释的开头就可以省略这个标签@enum类中属性的类型相同,用这个标签来标记@example例子,代码可以自动上级@exports标记这个对象将被导出到外部调用@ignore忽略这个注解@link内联标签,创建一个标签。比如'{@linkhttp://github.comGithub}'@name指定一段代码的名字,强制JsDoc使用这个名字而不是代码中的名字@namespace指定一个变量命名空间变量@static描述不需要即用型变量的实例@summary描述信息的简短概述@throws描述将发生的错误和异常@todo描述函数做什么以及它做了什么@tutorial插入向导的链接tutorial@see标签可以让你引用可能相关的东西另记录相关的符号或资源开发工具sublime+DocBlockr/**Tab(回车)自动生成注释在注释中回车自动生成*输入@会自动提示标准注释的标签文档输出YUIDoc不解析文本,完全按照注释标签生成文档,与代码分离NodeJs环境安装YUIDocnpminstall–gyuidocjs使用输入yuidoc。在对应目录下,会在当前目录下生成一个out文件,里面会生成注解文档在对应目录下输入yuidoc。–server
