Peiris
asked on
Best practice for php comments
Hi
I would like to know what is the best practice when commenting php function revisions. I am working on a project with some other developers and methods we have written get updated due to bug fixes and new feature additions. Sometimes its hard to understand the who did what in to a method. We are using bzr for version control system. but I would like to add the @version to a method and put a small comment to tell what I did with the method. What is the best syntax for this.
I am currently thinking to use the following
/**
* Create order to disconnect service, implemented from Service_Orders_Interface
* @access public
* @return int
* @version 1.1 @author name @comment comments
* @version 1.2 @author name @comment comments
*/
I would like to know what is the best practice when commenting php function revisions. I am working on a project with some other developers and methods we have written get updated due to bug fixes and new feature additions. Sometimes its hard to understand the who did what in to a method. We are using bzr for version control system. but I would like to add the @version to a method and put a small comment to tell what I did with the method. What is the best syntax for this.
I am currently thinking to use the following
/**
* Create order to disconnect service, implemented from Service_Orders_Interface
* @access public
* @return int
* @version 1.1 @author name @comment comments
* @version 1.2 @author name @comment comments
*/
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
+1 for @Roads_Roads!
ASKER
This solve my question
http://en.wikipedia.org/wiki/PHPDoc