diff options
author | Yasuo Ohgaki <yohgaki@php.net> | 2014-01-26 18:28:21 +0900 |
---|---|---|
committer | Stanislav Malyshev <stas@php.net> | 2014-01-26 17:20:12 -0800 |
commit | 60bcf84ddaa281f1e803b11a7db77d8a7f8c58c6 (patch) | |
tree | ddfd36b5a85c358fc05b1d906a9b8f3d97d970ba /CODING_STANDARDS | |
parent | d5560faaa3595c4aaf46329e4714432c42244503 (diff) | |
download | php-git-60bcf84ddaa281f1e803b11a7db77d8a7f8c58c6.tar.gz |
Update source docs
Diffstat (limited to 'CODING_STANDARDS')
-rw-r--r-- | CODING_STANDARDS | 25 |
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 |