文档注释是在「/**...*/」中以一定的规则来描述的注释。下面是给Member类添加文档注释的例子。
●清单 8-05 Member.js
管理成员信息
姓
名
缺少firstName或者lastName
缺少firstName或者lastName
显示成员的详细信息
成员的姓名
请改用{@link Member#toString}方法。
将Member类的内容转为字符串
成员的姓名
成员文档使用如下2中标签，标记文档化的信息。
- 以「@tag」的形式书写的块标签
→ 除去行头的星号／空格／分隔字符等，必须放在行的开头 - 以「{@tag}」的形式书写的内联标签
→ 可以嵌入注释或者块标签的说明中
在文档生成工具中，会根据这些标签信息获取生成文档所需的信息。
下面是主要的标签。具体的写法请参考JSDoc的文档（http://usejsdoc.org/）。
标签 概要
作者
关于类的说明
构造函数
版权信息
默认值
不推荐
用例
链接
标签 概要
命名空间
参数信息
私有成员
返回值
支持的版本
异常
版本
●文档注释中使用的主要标签