Project

General

Profile

Using Docblocks for quality code documentation » History » Version 13

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