Adding correct phpDoc

Description:

Each class or method should include the php documentation at the beginning of the definition.

Solution:

The average phpDoc for a PhP class should contain the following information:

/**
* Short description of the class/method
* Long description of the class/method
* @author First name Last name <name@emailprovider.dom>
* @since Start date
* @see Wiki documentation link
* @package Name of the container module
* @param Type Name Description
* @return Type Name
*/

Of course, for methods inside a class, redundant information should be excluded.

Advertisements

About admin

Just another php developer trying to give something back to the community.
This entry was posted in Best practices and tagged , , . Bookmark the permalink.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s