3,035
edits
Update:Remora Standards: Difference between revisions
→Style
(→Style) |
|||
| Line 2: | Line 2: | ||
= Style = | = Style = | ||
Follow the [http://pear.php.net/manual/en/standards.php PEAR Coding Standards] with | Follow the [http://pear.php.net/manual/en/standards.php PEAR Coding Standards] with one exception: | ||
== No new line at EOF == | == No new line at EOF == | ||
[http://pear.php.net/manual/en/standards.file.php Leaving a new line] at the end of a .php file after the ?> will make horrible things happen for HTTP headers. '''Do not follow this standard'''. | [http://pear.php.net/manual/en/standards.file.php Leaving a new line] at the end of a .php file after the ?> will make horrible things happen for HTTP headers. '''Do not follow this standard'''. | ||
= Comments and PHPDoc = | |||
* Read and understand the [http://manual.phpdoc.org/HTMLframesConverter/DOM/default/ PHPDoc reference] when needed. | * Read and understand the [http://manual.phpdoc.org/HTMLframesConverter/DOM/default/ PHPDoc reference] when needed. | ||
* Make a concerted effort to [write out comments], especially before function definitions. Bare minimum comments for function defs: | * Make a concerted effort to [write out comments], especially before function definitions. Bare minimum comments for function defs: | ||