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 the new standards of the 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.

List of Document Tags¶

@package
@subpackage
@author
@link
@copyright
@license
@author
@access
@todo
@see
@param
@return

Optional Document Tags¶

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.

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.

...