summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source
diff options
context:
space:
mode:
authorPhil Sturgeon <email@philsturgeon.co.uk>2012-04-26 23:44:22 +0200
committerPhil Sturgeon <email@philsturgeon.co.uk>2012-04-26 23:44:22 +0200
commit6fb427d151ed18622b86453581cc22989715ddc3 (patch)
treefa8f66d03745652c508029d0ca77537f37230dfc /user_guide_src/source
parent79ac3d1f6e21d199971471586df22011206f868a (diff)
parentf59bb1ac944dfaed23150ffd452ce5bca9f5f5c0 (diff)
Merge pull request #1266 from timw4mail/patch
Normalize comments in core files
Diffstat (limited to 'user_guide_src/source')
-rw-r--r--user_guide_src/source/general/styleguide.rst13
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.