JS注释&YUIDoc

罗志环发布于2019-08-22 17:24 / 3075人阅读

摘要：标签描述一组关联的类对于没有类，只是把有构造方法也归为类罢了。在库中通常是个构造函数。每个有标签的注释块都应该有一个或者的副标签。你将会用到和副标签加以说明。描述类中的属性描述你自定义的可触发事件。

介绍作用

合作分享：方便他人阅读，便于分享

沉淀总结：容易忘记代码，总结沉淀

形式

// 双斜杠

/**/ 斜杠星号

常用标签

标签	描述
@module 1	标明当前文件模块，在这个文件中的所有成员将被默认为属于此模块，除非另外标明
@submodule 1	针对模块的划分，处于@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	插入一个指向向导教程的链接
@see	标签允许您引用可能与被记录的相关的另一个符号或资源

开发工具

sublime+DocBlockr

/** Tab(回车)自动生成注释

在注释中回车自动生成 *

输入@会自动提示标准注释的标签

文档输出

YUIDoc
不解析文本，完全按照注释标签进行生成文档，与代码分离
NodeJs环境

安装YUIDoc

npm install –g yuidocjs

使用

在相应的目录下输入 yuidoc . ，会在当前目录生成 out文件，里面生成注释文档

在相应的目录下输入 yuidoc . –server ，会使用nodejs环境生成对应的网站

更多标签可参考：

YUIDoc

JsDoc

编写Js注释

以 /* 开头，/ 结束

按照层级格式编写：@module,[@sumodule],@class,@method,@property等层级格式

@method，@property，@param等必须在@class下面

每个标签快里面只能包含下面一个标签，描述了当前代码块的作用。

@module 标签描述一组关联的类（对于JS 没有类，YUIDoc只是把有构造方法也归为类罢了）。

@class标签专门描述类的。在YUI库中通常是个构造函数。每个有@class 标签的注释块都应该有一个@static 或者 @constructor的副标签。

@method 描述类中的方法。你将会用到 @return 和 @params 副标签加以说明。

@property 描述类中的属性

@event 描述你自定义的可触发事件。YUIDoc文档里指出

GPU云服务器云服务器 yuidoc js注释 js 取消注释 js快捷注释

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/95139.html

Javascript自动化文档工具：YUI Doc, JSDoc 3, JSDuck等比较

摘要：本文比较了种较为主流的注释文档生成工具。应该说是非常适合开源项目多个作者共同维护的一个文档工具。最后我选择了作为文档生成的工具。为了支持多种语言，它仅对注释块内部的内容进行解析。最近随着写Node以及独立的CommonJS模块越来越多，我发现有一份好的文档不仅可以帮助自己在应用这些接口的时候不至于迷糊，而且对于共同开发的情况下，能够省去大量团队的交流和Debug的时间。本文比较了...

tyheist 2019-08-22 10:56 评论0 收藏0
利用Gulp实现JSDoc 3的文档编写过程中的实时解析和效果预览

摘要：所有关于的推荐文章中，都提到了自身配有的一个小工具。说到底还是为了方便实验以及实验对的使用，并没有过多考虑实际生产环境中的效率问题。关于不同的Javascript文档生成工具，可以参考我之前写的一篇文章《Javascript自动化文档工具：YUI Doc, JSDoc 3, JSDuck等比较》。本文中则要讲讲如何能够基于Gulp构建一个快速帮你预览对应注释所生成文档的小工具。所...

娣辩孩 2019-08-22 10:56 评论0 收藏0
五分钟玩转文档化工具JSDuck

摘要：我们在对现在较主流的五个文档工具分别作了调研和尝试，得到结论如下工具优点缺点提供了完整的模板开发事件触发等接口，使用非常灵活。至此，的环境部署已经全部完成了。字数：981 阅读时间：5分钟选型依据在经历了数个上线的项目之后，笔者所在的团队已经沉淀了一个相对稳定版本的前端框架。因此，我们需要出具一套框架API文档，以便公司其他成员的使用和框架的后期维护。我们在对...

rickchen 2019-08-21 18:41 评论0 收藏0
如何自制 JS 注释文档生成工具

摘要：组件的选择命令行工具首先我们需要一个命令行工具来方便的执行命令，这里我们选择组件，如果不喜欢使用且有能力的人完全可以通过组件自己封装执行命令函数。对于一个成熟的项目而言，一定需要一个注释文档生成工具，我们有很多可选的开源项目，如jsdoc、yuidocjs 等等，拥有这些强大的工具我们完全可以胜任任何注释方面的管理了么？一个成熟的开发者都会知道不管怎么样的项目都会在不同的开发条件下...

Cristalven 2019-08-19 18:44 评论0 收藏0
JavaScript代码注释范例

摘要：包含描述与指定所有参数和返回值的类型和值的注释标签。返回值的类型和描述或者更多示例更多请参考以下网站为本文参考，欢迎留言纠正。注解注释原文代码注释规范与示例注释 JavaScript代码注释范例做为一个有情怀的Coder，最近收集了一下JavaScript代码注释范例，希望能够帮助大家撸得一手妖媚而又放荡的Bug。普通注释单行注释使用 // 作为单行注释。单行注释符后与注释内...

int64 2019-08-22 17:56 评论0 收藏0