Documentation statistics for VCL for PHP

Posted by on in Blogs
We have been adding some stats to the phpDoc software we use to generate VCL for PHP documentation, so we know what we need to do in order to complete and improve, and here are the results:


Stats
-----
Total number of elements:5640
No clase elements:250
Classes:180
Methods:4473
Fields:737
-----
Documented:5519
Undocumented:121
Doc quality:97.854609929078 %
Elements with @see:37.68056128766 %
Elements with @example:7.5113495666529 %
-----
Documentation quality table
-----
37.185307470078 % with 2 lines of documentation
18.324391250516 % with 3 lines of documentation
11.019397441189 % with 4 lines of documentation
4.5398266611638 % with 5 lines of documentation
2.0635575732563 % with 6 lines of documentation
26.867519603797 % with more than 7 lines of documentation
-----


So we need to:

  • Document undocumented elements (121)

  • Complete less documented elements so they have, at least, 5 lines of documentation each

  • Increase the percentage of elements with @see and @example

Tags: VCL4PHP


Comments

Check out more tips and tricks in this development video: