Project

General

Profile

Using Docblocks for quality code documentation » History » Version 11

Simon Hodgkiss, 01/22/2010 02:40 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 3 Simon Hodgkiss
5 8 Simon Hodgkiss
6 9 Simon Hodgkiss
h3. Each file must keep the same docblock at the top of each file up to the following line. 
7 9 Simon Hodgkiss
8 8 Simon Hodgkiss
"// Check to ensure this file is included in Joomla!
9 1 Simon Hodgkiss
defined('_JEXEC') or die('Restricted access');"
10 1 Simon Hodgkiss
11 9 Simon Hodgkiss
h3. The top copyright is to stay the same.
12 9 Simon Hodgkiss
13 8 Simon Hodgkiss
However you make add the @copyright into the top docblock of any of code your wish to add additional copyright to.
14 8 Simon Hodgkiss
15 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. 
16 4 Simon Hodgkiss
17 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.
18 4 Simon Hodgkiss
The other is a blank file which has the basic template for you to drop any code into.
19 7 Simon Hodgkiss
20 7 Simon Hodgkiss
If you do not require all the @tags when documenting your code feel free to take them out.
21 11 Simon Hodgkiss
22 11 Simon Hodgkiss
23 11 Simon Hodgkiss
24 11 Simon Hodgkiss
25 11 Simon Hodgkiss
26 11 Simon Hodgkiss
27 11 Simon Hodgkiss
28 11 Simon Hodgkiss
29 11 Simon Hodgkiss
30 11 Simon Hodgkiss
31 11 Simon Hodgkiss
...