购物车
登陆 / 注册
微信扫码登陆

@kind

@kind
@kind标签是用来指明什么样的标识符被描述(例如,一类或模块)。标识符kind 不同于标识符type(例如,字符串或布尔)。
编辑:青灯夜游 青灯夜游 更新时间:2019-01-07 14:46:58

@kind

描述: 标识的类型。

Syntax(语法)

@kind <kindName>

<kindName>取值为:

  • class
  • constant
  • event
  • external
  • file
  • function
  • member
  • mixin
  • module
  • namespace
  • typedef

Overview(概述)

@kind标签是用来指明什么样的标识符被描述(例如,一类或模块)。标识符kind 不同于标识符type(例如,字符串或布尔)。

通常你不需要@kind标签,因为标识符的kind是由doclet的其他标记来确定。例如,使用@class标签自动意味着“@kind class”,使用@namespace标签则意味着“@kind namespace”。

Examples(例子)

例如,使用 @kind:

// The following examples produce the same result:
/**
 * A constant.
 * @kind constant
 */
 const asdf = 1;
 /**
 * A constant.
 * @constant
 */
 const asdf = 1;

kind标签可能引起冲突(例如,使用 @module,表示他的kind为"module",同时,又使用了"@kind constant",表示他的kind为"constant"),在这种情况下最后的标签决定kind 的值。

例如,冲突的@kind语句:

/**
 * This will show up as a constant
 * @module myModule
 * @kind constant
 */
 /**
 * This will show up as a module.
 * @kind constant
 * @module myModule
 */
网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
文章列表
教程文档
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号