Project

General

Profile

Actions

Using Docblocks for quality code documentation » History » Revision 7

« Previous | Revision 7/35 (diff) | Next »
Simon Hodgkiss, 01/22/2010 02:33 PM


Using Docblocks for quality code documentation

Information to all developers

The way in which each file should be documented has changed slightly. You may have already seen some changes to a few of the files already. Here you will find all the references you will need to keep your files to out new Docblock documentation.

I have provided you with two files for each type one which has comments on how the document tags work and which should be used.
The other is a blank file which has the basic template for you to drop any code into.

If you do not require all the @tags when documenting your code feel free to take them out.

Updated by Simon Hodgkiss almost 15 years ago · 7 revisions