Re: PHPDoc

(this is mostly a note to Antonio himself, however I'm raising some issues I'd like other's to comment on, specifically the creation of new PHPDoc tags. -timmyg) I have committed my changes to cvs. You should be able to get a current copy from there. Are you any good with regular expressions? I'd like to have the @exclude and @todo implemented next. Also, I'd like to discuss (probably on the PEAR list) what tag to use for multiple code examples. My argument for wanting to have them embedded in the source code is twofold: 1. It makes it easier for people to see an example of how to use a particular class if they look at it. 2. It's easier for a programmer to remember to update what's right alongside his code. @example is one idea. for multiple examples one would simply use additional @example tags. /** * Short Description * Long Description * @package * @example (everything else on this line is ignored. * A description goes here that is printed above the example. // code goes here with no * in front. echo "hello world."; * A description goes here that is printed below the example. */ So... what's needed is some regular expressions to accomplish the above, however, they need to work in the context of the existing code. I've delved into the code a little bit; if you haven't, I'd recommend running a phpdoc on the code, and examining that. Once you get into the code a little ways, it'll start making sense. Ulf used a lot of inheritance and some objects seem to use methods from objects that inherit a base object. In other words, b extends a. a calls methods in b using $this->blah() form. (correct me if I'm wrong, Ulf - this is perhaps a hasty remark, and should be subject to review) Not to say it's coded poorly, it just makes it slightly confusing at first. And should my comment prove to be incorrect, I still say that I found the code difficult to comprehend at first. However, I use PHPDoc all the time so I shouldn't complain. :) -timmyg At 05:06 PM 4/11/2002 -0300, Antonio wrote:

As I told in earlier mail I'm thinking to make my Graduation Conclusion Tesis at College about PHPDoc.

        So I wanna help you in development. If you want a little help with it

just tell me where to get the files so I can understand well how it works and how could I help you. =)