Using Docblocks for quality code documentation » History » Revision 34
Revision 33 (Simon Hodgkiss, 01/22/2010 03:00 PM) → Revision 34/35 (Simon Hodgkiss, 01/22/2010 03:03 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 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.
h3. Optional Document Tags
You can add the @copyright into the docblock above any of code your wish to add additional copyright to.
@todo can be used to place reminders with your code.
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.
h3. List of Document Tags
@package
@subpackage
@author
@link
@copyright
@license
@author
@access
@todo
@see
@param
@return
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.
...