Project

General

Profile

Using Docblocks for quality code documentation » History » Version 18

Simon Hodgkiss, 01/22/2010 02:47 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 1 Simon Hodgkiss
h3. 2. The top copyright is to stay the same.
9 16 Simon Hodgkiss
10 17 Simon Hodgkiss
h3. 3. The minimum Docblock you should use has to have at least: 
11 17 Simon Hodgkiss
12 18 Simon Hodgkiss
/**
13 18 Simon Hodgkiss
* Description 
14 18 Simon Hodgkiss
* 
15 18 Simon Hodgkiss
* @copyright
16 18 Simon Hodgkiss
* @author 
17 18 Simon Hodgkiss
*/
18 17 Simon Hodgkiss
19 15 Simon Hodgkiss
However you make add the @copyright into the docblock of any of code your wish to add additional copyright to.
20 12 Simon Hodgkiss
21 13 Simon Hodgkiss
22 8 Simon Hodgkiss
23 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. 
24 4 Simon Hodgkiss
25 4 Simon Hodgkiss
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.
26 4 Simon Hodgkiss
The other is a blank file which has the basic template for you to drop any code into.
27 7 Simon Hodgkiss
28 7 Simon Hodgkiss
If you do not require all the @tags when documenting your code feel free to take them out.
29 11 Simon Hodgkiss
30 11 Simon Hodgkiss
31 11 Simon Hodgkiss
32 11 Simon Hodgkiss
33 11 Simon Hodgkiss
34 11 Simon Hodgkiss
35 11 Simon Hodgkiss
36 11 Simon Hodgkiss
37 11 Simon Hodgkiss
38 11 Simon Hodgkiss
39 11 Simon Hodgkiss
...