« Previous - Version 30/35 (diff) - Next » - Current version
Simon Hodgkiss, 01/22/2010 02:55 pm


Using Docblocks for quality code documentation

Important information to developers

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.

1. The top Docblock should stay the same in all files.
2. The top copyright is to stay the same.
3. The minimum Docblock you should use has to have at least: A Description, @package    VirtueMart and an @author.

Optional

You can add the @copyright into the docblock above any of code your wish to add additional copyright to.

If you do not require all the @tags when documenting your code feel free to take them out.

Sample files

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.
The other is a blank file which has the basic template for you to drop any code into.

...

controllers.txt Magnifier - Controller Template (1.19 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

general.txt Magnifier - General Template (677 Bytes) Simon Hodgkiss, 01/22/2010 02:32 pm

model.txt Magnifier - Model Template (1.15 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

table.txt Magnifier - Table Template (1.11 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

controllers_template.txt Magnifier - Explained Controller Template (1.89 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

general_template.txt Magnifier - Explained General Template (673 Bytes) Simon Hodgkiss, 01/22/2010 02:32 pm

model_template.txt Magnifier - Explained Model Template (1.86 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

views.txt Magnifier - Views Template (1.04 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

table_template.txt Magnifier - Explained Table Template (1.83 KB) Simon Hodgkiss, 01/22/2010 02:32 pm

views_template.txt Magnifier - Explained Views Template (1.71 KB) Simon Hodgkiss, 01/22/2010 02:32 pm