Using Docblocks for quality code documentation » History » Version 31

Version 30 (Simon Hodgkiss, 01/22/2010 02:55 PM) → Version 31/35 (Simon Hodgkiss, 01/22/2010 02:55 PM)

h1. Using Docblocks for quality code documentation

h2. 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.

h3. 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 as long as it meets the minimum requirements. out.

h3. 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.