This is an old revision of the document!
Table of Contents
Coding Standards
As the ADOdb project has moved from an owner-controlled project to a more distributed-development environment we have adopted the following coding standards for the ADOdb project, based on their existing widespread use.
Version Numbering
Release versions numbering follows the standards defined at Semantic Versioning
Code Documentation
Code is documented to guidelines defined at PHPDocumentor. In order to add missing documentation, a templated docblock will be added to each file, function, class 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 docblock for the modified function. Once we have cleaned up a substantial portion of the code, we will start producing PHP documentor files and include it in the releases.
Coding Standards
Please code to PEAR standards.
Code style validation can be done using PHP_CodeSniffer
Testing
There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around PHPunit tests.
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-function-status
This tag indicates that the argument documentation has not yet been reviewed. If you have reviewed this documentation, and added any necessary comments, then remove the tag.
adodb-api
If you review the function and it conforms to the requirements defined by the phpdocumentor api tag, then:
- Remove the adodb-api tag
- add the @api tag
If the function does not conform, simply remove the adodb-api tag.
Method Tags
adodb-visibility
If you can identify the visibility of a method (public/protected/private), change the value of the tag to reflect this. Please do not change the method itself, this will be done in a later release.
adodb-function-status
This tag indicates that the argument documentation has not yet been reviewed. If you have reviewed this documentation, and added any necessary comments, then remove the tag.
adodb-api
If you review this method and it 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.
Apologies
If you have your own tools built around the original documentation standards, we apologize for the inconvenience.