| View previous topic :: View next topic |
| Author |
Message |
leon_pegg
Joined: 12 Jun 2006 Posts: 113 Location: hemel / UK
|
|
| Back to top |
|
 |
cweiske
Joined: 08 Dec 2005 Posts: 454 Location: Leipzig/Germany
|
Posted: Sun Nov 12, 2006 9:21 pm Post subject: |
|
|
Leon, you might want to get used to phpdoc tags in comments.
For example, return types are expressed with "@return bool Some description" |
|
| Back to top |
|
 |
leon_pegg
Joined: 12 Jun 2006 Posts: 113 Location: hemel / UK
|
Posted: Sun Nov 12, 2006 9:43 pm Post subject: |
|
|
| will look into it never had to use phpdoc tags, at work we use are own documentation software. |
|
| Back to top |
|
 |
cohort
Joined: 07 Feb 2006 Posts: 47
|
Posted: Mon Nov 13, 2006 1:04 am Post subject: |
|
|
Some reasons for using phpdoc comments:
- if you should want it posted to a PEAR-based repository, the repository software generates web documentation via phpdoc automagically.
- it's freely available in PEAR, so if people want to generate their own docs for it, they can.
- many people have been conditioned to read phpdoc-style comments anyway. |
|
| Back to top |
|
 |
|