3,035
edits
Update:Remora Standards: Difference between revisions
Jump to navigation
Jump to search
no edit summary
No edit summary |
No edit summary |
||
| Line 29: | Line 29: | ||
[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 == | |||
* Make a concerted effort to write out comments, especialy before function definitions. Bare minimum comments for function defs: | |||
** What it is for | |||
** @param - define all inputs and their type/purpose | |||
** @return - define all retvals and their type/purpose | |||
* // style comments can be used for smaller statements, just footnotes. If they footnote turns into an essay, use /** */ | |||
= Testing = | = Testing = | ||
* [[Update:Remora_Testing|Remora Testing Page]] | * [[Update:Remora_Testing|Remora Testing Page]] | ||