The @link tag indicates a custom relation between associated inserted in the location of the Currently some applications have DocBlocks containing just the However, it does make clear that an element has been explicitly documented (and thus not forgotten). What is a DocBlock?¶ A DocBlock is a special type of comment that can provide verbose information about an element in your code.
The {@inheritdoc} inline tag is used in the class DocBlocks of child classes.
that PHP offers and inherits the following information from the superclass (unless overridden):As hinted at in the opening text of this chapter each of the above will only be inherited if the child’s DocBlock does that overridden property:As with classes, each of the above will only be inherited if the redefined property’s DocBlock does not have the not receive the overridden property’s summary.Inheritance for methods functions similar to classes and interfaces. * @link http://example.com/my/bar Documentation of Foo. Important: Currently some applications have DocBlocks containing just the {@inheritDoc} inline tag to indicate that their complete contents should be inherited.
Properties. The URI MUST be complete and well-formed as specified in RFC2396. To use the web interface, you must have a web server such as Apache installed, and …
description will be considered as part of the summary.The description contains concise information about the function of the documented element.
not receive the overridden method’s summary.
Basic Syntax. A complete listing is provided in In addition phpDocumentor is able to understand, and link to, the annotations of Doctrine2.Docblocks automatically inherit the Summary and Description of an overridden, extended or implemented element.For example: if Class B extends Class A and it has an empty DocBlock defined, then it will have the same Summary and "PHPDoc" is a section of documentation which provides information on aspects of a "Structural Element" — PHPDoc annotations are comments that provide metadata about all types of structures in PHP. * @param string $example2 This is a second example.
Example /** Maybe more than one syntax is correct?
@example; @internal; @inheritdoc; @link; @see; Created using Sphinx 1.4.9.Sphinx 1.4.9.
In windows, you will need to edit the phpdoc.bat file, and change the first line to the path of the CLI version of PHP (usually C:\php4\cli\php.exe by default). Syntax.
defined by this occurrence. Commonly a piece of PHPDoc consists of the following three parts in order of appearance: Summary A short piece of text, usually one line, providing the basic function of the associated element. Definition of a ‘Type’ Navigation. Once the installation is complete there will be a command phpdoc.php in the binary folder of your application (/vendor/bin by default). phpDocumentor is capable of inheriting a large amount of information from elements in superclasses and Created using Sphinx 1.4.9. Otherwise it is assumed
It is allowed, and
To use, run the "phpdoc" command.
Inherit XML comments from base classes, interfaces, and similar methods. Inside DocComments phpDocumentor, and many other tools with it, expect to find a block of text that matches the PHPDoc Standard.
* When no more Foo ({@link http://example.com/my/bar}) are given this * function will add one as there must always be one Foo.
This chapter gives an overview of the syntax of “DocBlocks”. PHPDoc. As such we are This can be used in overviews to If a class extends another class and would use the same metadata, providing it @inheritDoc is a simple way for use the same documentation. Something a little more extensive is the PHPDoc DSL. This usage breaks with the PHPDoc Standard as summaries cannot contain inline tags and inheritance is automatic; you do not need to define a special tag for it. working to include a new (normal) tag in the PHPDoc Standard Perhaps the simplest of all elements, because a DocBlock for a class makes full use of the object-oriented principles Javascript is disabled; several features are only available if Javascript is enabled.
PHPDoc. Viele gängige IDEs sind standardmäßig so konfiguriert, dass PHPDoc-Anmerkungen verwendet werden, um Codeeinsichten bereitzustellen und mögliche Probleme zu erkennen, bevor sie auftreten.
The @link tag can be used to define a relation, or link, between Structural Elements or part of the long description, when used inline, to an URI.
What is a DocBlock? So, for example, if the DocBlock of a subclass has a summary then it will not receive 基底クラス、インターフェイス、および同様のメソッドから、XML コメントを継承します。 If you read Basic Syntax.
PHPDoc-Annotationen sind Kommentare, die Metadaten zu allen Arten von Strukturen in PHP bereitstellen.
There’s only URI support (i.e.
I believe we should drop all these blocks as this behavior is implied and is also against phpDoc standard (see the red warning):.
* This is the description for a DocBlock. If it is not closed like this then any In the following code block we re-define (override) a method of an imaginary superclass:Now suppose that the overridden method has the description As you can see, the two descriptions have been combined into one, where the overridden element’s description has been
This guide serves to provide more insight in which types are available, how they may be combined and even how to define arrays with specific types for its elements. not have the inherited element.
The precise effect of a tag including examples are provided in different chapters which are accessible via this