phpdoc注释规范 - 介绍相关参考内容 ¶

• 作者：KK

• 发表日期：2016.9.17

当一个被注释的东西在使用时需要告诉程序员要参考一些内容的时候，那就可以在备注块里增加@see http://xxxx地址或者@see 当前类的其他方法名()还有@see \path\to\类::方法（引用其他类的方法）

在属性注释中添加参考资料 ¶

注释格式：@see 链接地址|方法 说明

class Email{
	/**
	 * @var string 收信地址
	 * @see http://www.rfc-editor.org/errata_search.php?eid=1690 RFC1690号文档说明了该地址的格式和长度
	 */
	public $address = '';
}

浏览效果：

在方法注释中添加参考资料 ¶

其实和属性的一样，甚至在类里面，在常量里添加都可以

class MySql{
	/**
	 * 添加一个and条件
	 * @param mixed $condition 条件
	 * @see where() 和这个方法的参数的书写格式一样
	 * @see \framework\db\Query::where 也和这个方法的参数的书写格式一样
	 * @return static
	 */
	public function andWhere($condition){}
}

这里也演示了添加多个@see，浏览效果如下:

如果用yii2-apidoc来生成的话会比较好，这样会有超级链接，点击后还会跳转到相关方法的文档页面或者网址：