diff options
| author | Andrey Andreev <narf@bofh.bg> | 2012-04-27 10:54:40 +0200 |
|---|---|---|
| committer | Andrey Andreev <narf@bofh.bg> | 2012-04-27 10:54:40 +0200 |
| commit | ce747c8a1e72a30f5369de7d56ba91b72f0e2eb3 (patch) | |
| tree | 32433143610df1683131dba5cf4437ddadc306c6 /user_guide_src/source/general/styleguide.rst | |
| parent | 870ad190f068ec16aad45622528ba6747c61c120 (diff) | |
| parent | 61318a2c53c13a314f483fcbbfd64c6e01f5242c (diff) | |
Merge upstream branch
Diffstat (limited to 'user_guide_src/source/general/styleguide.rst')
| -rw-r--r-- | user_guide_src/source/general/styleguide.rst | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst index d8bdd0531..925954c03 100644 --- a/user_guide_src/source/general/styleguide.rst +++ b/user_guide_src/source/general/styleguide.rst @@ -94,7 +94,7 @@ overly long and verbose names. class Super_class { - function __construct() + public function __construct() { } @@ -149,7 +149,7 @@ months down the line. There is not a required format for comments, but the following are recommended. `DocBlock <http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock>`_ -style comments preceding class and method declarations so they can be +style comments preceding class, method, and property declarations so they can be picked up by IDEs:: /** @@ -168,11 +168,21 @@ picked up by IDEs:: /** * Encodes string for use in XML * - * @access public * @param string * @return string */ function xml_encode($str) + +:: + + /** + * Data for class manipulation + * + * @var array + */ + public $data + + Use single line comments within code, leaving a blank line between large comment blocks and code. |