project:standards
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
standards [2015/11/28 18:59] – mnewnham | project:standards [2016/01/31 19:36] (current) – mnewnham | ||
---|---|---|---|
Line 2: | Line 2: | ||
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. | 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 ===== | ===== Version Numbering ===== | ||
- | Release versions numbering follows the standards defined at [[http:// | + | Release versions numbering |
===== Code Documentation ===== | ===== Code Documentation ===== | ||
- | Code is documented to guidelines defined at [[http:// | + | ADOdb Version 6 Code will be documented to guidelines defined at [[http:// |
===== Coding Standards ===== | ===== Coding Standards ===== | ||
- | Please code to [[https://pear.php.net/manual/en/standards.php|PEAR standards]]. | + | ADOdb Version 6 will be coded to the PHP Framework Interop Group [[http://www.php-fig.org/psr/psr-2/|PSR-2]] standards. |
Code style validation can be done using [[http:// | Code style validation can be done using [[http:// | ||
===== Testing ===== | ===== Testing ===== | ||
There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around [[https:// | There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around [[https:// | ||
- | ===== 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/ | ||
- | ==== Function Tags ==== | ||
- | === adodb-function-status === | ||
- | This tag indicates that the argument documentation has not yet been reviewed. If you have reviewed this documentation, | ||
- | === adodb-api === | ||
- | If you review the function and it conforms to the requirements defined by the phpdocumentor [[http:// | ||
- | - 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/ | ||
- | === adodb-function-status === | ||
- | This tag indicates that the argument documentation has not yet been reviewed. If you have reviewed this documentation, | ||
- | === adodb-api == | ||
- | If you review this method and it conforms to the requirements defined by the phpdocumentor [[http:// | ||
- | - Remove the adodb-api tag | ||
- | - add the @api tag | ||
- | |||
- | If the method does not conform, simply remove the adodb-api tag. | ||
===== Apologies ===== | ===== Apologies ===== | ||
If you have your own tools built around the original documentation standards, we apologize for the inconvenience. | If you have your own tools built around the original documentation standards, we apologize for the inconvenience. | ||
+ | |||
+ | {{tag> |
project/standards.1448733557.txt.gz · Last modified: 2017/04/21 11:19 (external edit)