project:standards
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
standards [2015/11/11 03:43] – mnewnham | project:standards [2016/01/13 17:16] – [Code Documentation] mnewnham | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== 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 now follows the standards defined at [[http:// | ||
+ | ===== Code Documentation ===== | ||
+ | ADOdb Version 6 Code will be documented to guidelines defined at [[http:// | ||
+ | |||
===== Coding Standards ===== | ===== Coding Standards ===== | ||
- | We have adopted the following coding standards for the ADOdb project. | + | ADOdb Version |
- | ==== Version | + | |
- | Release versions numbering follows | + | |
- | ==== Code Documentation ==== | + | |
- | Code is documented to guidelines defined at [[http://phpdoc.org|PHPDocumetor]]. In order to add missing documentation, | + | |
- | ===== 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/ | + | |
- | ==== Function Tags ==== | + | Code style validation can be done using [[http:// |
- | === adodb-visibility | + | ===== Testing |
- | === adodb-function-status | + | There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around [[https:// |
- | === adodb-api === | + | |
- | ==== Method Tags ==== | ||
- | === adodb-visibility === | ||
- | === adodb-function-status === | ||
- | === adodb-api == | ||
- | If the method 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 | + | ===== Apologies ===== |
+ | If you have your own tools built around |
project/standards.txt · Last modified: 2016/01/31 19:36 by mnewnham