diff options
| author | Iban Eguia <admin@razican.com> | 2012-06-08 23:01:31 +0200 |
|---|---|---|
| committer | Iban Eguia <admin@razican.com> | 2012-06-08 23:01:31 +0200 |
| commit | 895e98c0f04f1087e8900ce8423ad3210a423770 (patch) | |
| tree | 6adfe487293df38807084599f1f04157b5531e54 /user_guide_src/source/general/styleguide.rst | |
| parent | 0ed4f63f4268b0c98f549ffd711702fd45a761d0 (diff) | |
| parent | a593c69de4ea125c096f611c78dd0839489e7ebd (diff) | |
Merge remote-tracking branch 'upstream/develop' into new_date
Diffstat (limited to 'user_guide_src/source/general/styleguide.rst')
| -rw-r--r-- | user_guide_src/source/general/styleguide.rst | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/user_guide_src/source/general/styleguide.rst b/user_guide_src/source/general/styleguide.rst index 2b91d1cc0..925954c03 100644 --- a/user_guide_src/source/general/styleguide.rst +++ b/user_guide_src/source/general/styleguide.rst @@ -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:: /** @@ -172,6 +172,17 @@ picked up by IDEs:: * @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. |