phpDoc in Eclipse - when the comments become more clear
Author: DeVoid
About importance of commenting of a code was spoken already many times. About importance of commenting of a code was spoken already many times.
If you would want that each class written by you was clear to you and your colleagues - can use the simple standard of record of the comments:
/ **
* Short description - used in indexlists
*
* Multiple line detailed description.
* The handling of line breaks and HTML is up to the renderer.
* Order: short description - detailed description - doc tags.
*
* @param string Target directory for the generated HTML Files
*/
If before the announcement of a class or method to write such comment - IDE will process it and will deduce to you the help at their further use. It is very convenient by collective development and large volumes of a code.
The purpose of methods becomes more clear, the transmitted parameters are deduced, the returned meanings are specified.
It is necessary to note that Eclipse automatically generates preparation under such style of the comment after introduction / ** and pressing Enter before the announcement of a method / class. And to receive the help it is possible on pressing Ctrl+Space after input $myClassName- >.
read comments (0)