search

theseer / phpdox

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
http://phpdox.de
Other
600 stars 121 forks source link

Documentation for DocBlock supported tags #48

Closed wadkar closed 13 years ago

wadkar commented 13 years ago

I am new to DocBlocks and I am trying to comment my code (rather religiously). I followed phpDoc and their documentation on how to write DocBlocks. However, I realized later that phpDoc is old (and sorta deprecated). I am on PHP 5.3+ and use namespaces/use statements a lot.

I would really appreciate if phpdox can help beginners like me to get introduced in DocBlock writing something one the lines of how/which tags to use (I am using VIP vim phpDoc plugin to insert DocBlocks).

I also see that some constructs like are not allowed/parsed by phpdox. I have followed phpDoc till now but would like to keep my knowledge/know how up to date.

One can think of starting with phpDoc's documentation about tags and add phpdox specific notes.

Thanks

wadkar commented 13 years ago

I just realized that phpdox is still in alpha, so I don't think this issue will get a high priority. However, i will be happy to checkout phpdox whenever it reaches beta (and hopefully I will be familiar with DocBlocks by then). Feel free to open/wontfix/whatever this issue.