Project

General

Profile

Using Docblocks for quality code documentation » History » Version 16

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

1 1 Simon Hodgkiss
h1. Using Docblocks for quality code documentation
2 2 Simon Hodgkiss
3 14 Simon Hodgkiss
h2. Important information to all developers
4 3 Simon Hodgkiss
5 8 Simon Hodgkiss
6 15 Simon Hodgkiss
h3. 1 . The top Docblock should stay the same in all files. 
7 1 Simon Hodgkiss
8
h3. 2. The top copyright is to stay the same.
9 16 Simon Hodgkiss
10 15 Simon Hodgkiss
However you make add the @copyright into the docblock of any of code your wish to add additional copyright to.
11 12 Simon Hodgkiss
12 13 Simon Hodgkiss
13 8 Simon Hodgkiss
14 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. 
15 4 Simon Hodgkiss
16
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.
17
The other is a blank file which has the basic template for you to drop any code into.
18 7 Simon Hodgkiss
19
If you do not require all the @tags when documenting your code feel free to take them out.
20 11 Simon Hodgkiss
21
22
23
24
25
26
27
28
29
30
...