Method comments are required
Forum /
Server Programming /
Method comments are required
Reply
Subscribe
Start new thread
Syndicated Feed (RSS)
|
Displaying 1 to 2 of 2
|
Previous
1
Next |
| Author |
Message |
Chriscypher
Posts: 4
|
|
Method comments are required - Posted: June 13, 2005 - 4:42 AM
|
Quote and reply
|
The comments which appear before each method in a bean file are REQUIRED.
phpBeans parses the bean file looking for comments in the form of:
/**
* Parses the specified file and returns the method list.
*
* @access public
* @param string
* @return array
*/
...preceeding each bean method.
If these comments are missing, the method may not be called from outside the bean.
This threw me for quite awhile, because I assumed that comments are for human-reference-only, not integral to the bean parsing mechanism.
I do not have a complete set of variable types, but am hopeful that it follows php conventions.
Hope this saves someone a day or two...
|
|
Back to top
|
|
ramsharma2k5
Posts: 1
|
Hi Chriscypher,
I could not get you. Is it like that we have to use comments there or we should write comments like you suggested. I mean is it neccessary to write comments or if we are writing comments then we should follow that pattern. Please don't mind if I asked something wrong.
Ram Sharma
|
|
Back to top
|
|
Return to Top
|
