Project

General

Profile

Using Docblocks for quality code documentation » History » Version 24

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

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