ADOdb

Database Abstraction Layer for PHP

User Tools

Site Tools


project:standards

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
standards [2015/11/28 18:59] mnewnhamproject: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://semver.org|Semantic Versioning]]+Release versions numbering now follows the standards defined at [[http://semver.org|Semantic Versioning]]
 ===== Code Documentation ===== ===== Code Documentation =====
-Code is documented to guidelines defined at [[http://phpdoc.org|PHPDocumetor]]. In order to add missing documentation, a templated docblock has been added to each file, function, class and methodEach docblock contains a number of custom adodb tagsThese tags are documented below. When modifying existing code, there is no need to fix all the documentation inside the filebut please update the documentation for the modified function+ADOdb Version 6 Code will be documented to guidelines defined at [[http://phpdoc.org|PHPDocumentor]]. If [[http://www.php-fig.org/psr|PHP-FIG PSR-5]] is acceptedADOdb documentation standards will likely encompass those as well. 
 ===== 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://pear.php.net/package/PHP_CodeSniffer/redirected|PHP_CodeSniffer]] Code style validation can be done using [[http://pear.php.net/package/PHP_CodeSniffer/redirected|PHP_CodeSniffer]]
 ===== 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://phpunit.de/|PHPunit]] tests. There are a number of tests available in the adodb/tests directory. Future releases will likely have a test suite built around [[https://phpunit.de/|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 [[http://phpdoc.org/docs/latest/references/phpdoc/tags/api.html|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 [[http://phpdoc.org/docs/latest/references/phpdoc/tags/api.html|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 ===== ===== 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>[semantic phpdocumentor codesniffer]}}
project/standards.1448733557.txt.gz · Last modified: 2017/04/21 11:19 (external edit)