Project

General

Profile

Using Docblocks for quality code documentation » History » Version 7

Simon Hodgkiss, 01/22/2010 02:33 PM

1 1 Simon Hodgkiss
h1. Using Docblocks for quality code documentation
2 2 Simon Hodgkiss
3 3 Simon Hodgkiss
h2. Information to all developers
4
5 6 Simon Hodgkiss
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. 
6 4 Simon Hodgkiss
7
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.
8
The other is a blank file which has the basic template for you to drop any code into.
9 7 Simon Hodgkiss
10
If you do not require all the @tags when documenting your code feel free to take them out.