summaryrefslogtreecommitdiff
path: root/CODING_STANDARDS
diff options
context:
space:
mode:
authorYasuo Ohgaki <yohgaki@php.net>2014-01-26 18:31:27 +0900
committerStanislav Malyshev <stas@php.net>2014-01-26 17:20:12 -0800
commitf496aac1f6fc2b3ef30d5ed9539dbfdf9b4a1892 (patch)
treeddfd36b5a85c358fc05b1d906a9b8f3d97d970ba /CODING_STANDARDS
parent76c098395df506692b1aba48ed0042cc1a27b491 (diff)
downloadphp-git-f496aac1f6fc2b3ef30d5ed9539dbfdf9b4a1892.tar.gz
Update source docs
Diffstat (limited to 'CODING_STANDARDS')
-rw-r--r--CODING_STANDARDS25
1 files changed, 22 insertions, 3 deletions
diff --git a/CODING_STANDARDS b/CODING_STANDARDS
index 7a0562e6ca..fccc2b873d 100644
--- a/CODING_STANDARDS
+++ b/CODING_STANDARDS
@@ -82,7 +82,7 @@ Exceptions:
library may need to control or free the memory, or when the memory in
question needs to survive between multiple requests.
-Naming Conventions
+User Functions/Methods Naming Conventions
------------------
1. Function names for user-level functions should be enclosed with in
@@ -163,6 +163,25 @@ Naming Conventions
'foobar'
'foo_bar'
+Internal Function Naming Convensions
+----------------------
+
+1. Exposed module API must be named 'php_modulename_function()' to avoid
+ symbol collision. They should be in lowercase, with words underscore
+ delimited. Exposed API must be defined in 'php_modulename.h'.
+
+ PHPAPI char *php_session_create_id(PS_CREATE_SID_ARGS);
+
+ Unexposed module function should be static and should not be defined in
+ 'php_modulename.h'.
+
+ static int php_session_destroy(TSRMLS_D)
+
+2. Main module source file must be named 'modulename.c'.
+
+3. Header file that are used by other sources must be named 'php_modulename.h'.
+
+
Syntax and indentation
----------------------
@@ -181,9 +200,9 @@ Syntax and indentation
of PHP or one of its standard modules, please maintain the K&R
style. This applies to just about everything, starting with
indentation and comment styles and up to function declaration
- syntax. Also see Indentstyle_.
+ syntax. Also see Indentstyle.
-.. _Indentstyle: http://www.catb.org/~esr/jargon/html/I/indent-style.html
+ Indentstyle: http://www.catb.org/~esr/jargon/html/I/indent-style.html
3. Be generous with whitespace and braces. Keep one empty line between the
variable declaration section and the statements in a block, as well as