theseer/phpdox — Issue #48: Documentation for DocBlock supported tags
Author: wadkar
Created: 2011-11-28 10:40:34+00:00
State: open

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