Skip to content

Tag reference

@see

The @see tag points from the described element to a related one: another class, a method, a property, a global constant, a variable, or an external page. It is the most general of the reference tags — where @uses and @used-by specifically describe a dependency relationship, @see only says “read also”.

Grammar

"@see" ( <Reference> | <URI> ) [ <Description> ]

Examples

A reference to another method.
/**
* @see Mailer::send()
*/
A reference to a class constant, with a description.
/**
* @see Status::ACTIVE The only value accepted here.
*/
A reference to an external page.
/**
* @see https://example.com/docs/delivery
*/

Names by platform

standard
@see

Parsing a @see tag produces a SeeTag instance exposing $reference: a CodeReference (for a class, function, method, constant, property or variable) or a UriReference (for an external page), depending on which form was written.

final class SeeTag extends ReferenceTag
{
public function __construct(
string $name,
UriReference|CodeReference $reference,
?DescriptionInterface $description = null,
) {
parent::__construct(
$name,
$reference,
$description,
);
}
}

@see may also be used inline, nested inside a description as a {@see ...} sequence, rather than only on its own line:

/**
* Sends the response. See {@see Mailer::send()} for the
* transport used.
*/

Defined by the PSR-19 draft @see proposal and phpDocumentor’s own @see reference.