ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


project:standards

This is an old revision of the document!


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, 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 documentation for the modified function.

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 this method and it conforms to the requirements defined by the phpdocumentor api tag, then:

  1. Remove the adodb-api tag
  2. add the @api tag

If the method 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:

  1. Remove the adodb-api tag
  2. add the @api tag

If the method does not conform, simply remove the adodb-api tag.

project/standards.1447211494.txt.gz · Last modified: 2017/04/21 11:19 (external edit)