PHP Code Commenting Standard

This thing is quite common and famous
I just talk about its syntax and application in practice.
Everything will be applied OOP in PHP.
Immediately make a reservation, the format is applicable to classes, their methods and properties,
and so that as a result of our labors, we should get not a Malyaka from the double slash,
and beautifully written documentation, this format should be used.

Practice

So, an example:

At first glance it looks not so beautiful, but there are a number of advantages.
The main advantage is the standard. Now about the amenities that Zend and Eclipse give us:

In the form of a hint-tip, the development environment shows us a detailed description of the function,
where you can see what format the input data should be and what we will get as a result. “But this is not all ©,”
there are systems for automatic creation of documentation,
and with their help you can get a full description of our project,
based only on the above comments. How it looks about:

This page is generated by the phpDocumetor system built into ZDE.

Comment syntax

Syntax for function or method
/ **
* Name or short description (class, method, property, function)
*
* Detailed description
* in several lines
*
* @name_tag value
* return datatype
* /

Property syntax
/ **
* Description
*
* var variable_type
* /
And lastly a list of tags with a description:

• @access [private | protected | public] (access control for item)
• @author Antonov A. <andreydust@gmail.com> (Author of the current item)
• @param datatype $ variable_name Description (Description for input parameter)
• return data type Description (Describes the type of data returned by a function or method)

Full list on phpDocumentor Manual .