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