This is an old revision of the document!
Table of Contents
Coding Standards
We have adopted the following coding standards for the ADOdb project.
Version Numbering
Release versions numbering follows the standards defined at Semantic Versioning
Code Documentation
Code is documented to guidelines defined at PHPDocumetor. In order to add missing documentation, a templated docblock has been added to each file, class function and method. Each docblock contains a number of custom adodb tags. These tags are documented below. When modifying existing code, there is no need to fix all the documentation inside the file, but please update the documentation for the modified function.
Coding Standards
Please code to PEAR standards. Validate using PHP_CodeSniffer
Custom ADOdb tags
File Tags
adodb-filecheck-status
adodb-codesniffer-status
adodb-documentor-status
Class Tags
adodb-class-status
If you can identify whether the class is final/abstract etc, change this tag to reflect the value. Please do not change the class itself. These changes will be made in a later release.
Function Tags
adodb-visibility
adodb-function-status
adodb-api
Method Tags
adodb-visibility
adodb-function-status
adodb-api
If the method conforms to the requirements defined by the phpdocumentor api tag, then:
- Remove the adodb-api tag
- add the @api tag
If the method does not conform, simply remove the adodb-api tag.