mirror/php-e107
1
0
Fork 0
mirror of https://github.com/e107inc/e107.git synced 2025-08-07 23:26:41 +02:00
Code Issues Releases Wiki Activity

Updated e107 Coding Standard (markdown)

Cameron
2020-05-25 12:12:23 -07:00
parent 26bd5b80f8
commit 51edb1b58b
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
e107-Coding-Standard.md

@@ -82,6 +82,20 @@ class myplugin_shortcodes extends e_shortcode
} }
``` ```
```
class news_form_ui extends e_admin_form_ui
{
function news_template($curVal,$mode)
{
if($mode === 'read')
{
return $curVal;
}
// ...
```
Routines are to be documented at both file and function level using phpDoc syntax. Where appropriate create supplementary pages of general documentation, and document individual variables. Routines are to be documented at both file and function level using phpDoc syntax. Where appropriate create supplementary pages of general documentation, and document individual variables.
When passing more than three or so parameters to a function, consider passing some of them in an array (especially convenient if many are optional) or if within a class, consider using vars. When passing more than three or so parameters to a function, consider passing some of them in an array (especially convenient if many are optional) or if within a class, consider using vars.