A standard for php javadoc tags ?
Among other things, writing a php code documentor leads to the question :
how to document magic methods and variables ? One way to answer would be to imagine a way to document them, and implement that in phpSimpleDoc, but this leads to a problem : maybe an other code documentor will propose an other way, so when users document their code, they will depend on a given documentation software. The guidelines found on phpDocumentor cover PHP4 and have been widely used and recent php code documentors generally implement them. PHP5 and PHP6 bring needs for new tags, and new PHP code documentors appear So it would be more convenient to have a kind of standard recommendation for PHP adaptation of javadoc tags. A list of tags, their meaning and syntax. That would be easier for code documentors writers, and users would not depend an a given documentation generator. I will try to find if a group working on this question exists. If you know about that, please let me know. |