On Sun, 2005-06-12 at 08:32, Chris Drozdowski wrote: > I need some help regarding documenting code. Say you have a > function/method that takes an object as a parameter and/or returns an > object. > > When documenting, do you specify the specific class of the object when > listing the datatype in the docblock @param and @return specs or do you > simply specify "object"? Specific type so that users of the function know what they can do with the returned object from reading the doc. Cheers, Rob. -- .------------------------------------------------------------. | InterJinn Application Framework - http://www.interjinn.com | :------------------------------------------------------------: | An application and templating framework for PHP. Boasting | | a powerful, scalable system for accessing system services | | such as forms, properties, sessions, and caches. InterJinn | | also provides an extremely flexible architecture for | | creating re-usable components quickly and easily. | `------------------------------------------------------------' -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
