diff options
| author | Timothy Warren <tim@timshomepage.net> | 2012-04-20 16:31:51 +0200 |
|---|---|---|
| committer | Timothy Warren <tim@timshomepage.net> | 2012-04-20 16:31:51 +0200 |
| commit | bb8ae01bff0fa7cb3b14fb5f1310d944c414cf81 (patch) | |
| tree | 59a7cf8505031a1c4095a26443bcd9b93cd7fcc7 /user_guide_src | |
| parent | 67cb3eef37fa826f56f61cfd2ac597052d9051f9 (diff) | |
added suggested styleguide addition for future consistency
Diffstat (limited to 'user_guide_src')
| -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. |