diff options
| author | David Boddie <david.boddie@nokia.com> | 2010-12-06 18:00:42 (GMT) |
|---|---|---|
| committer | David Boddie <david.boddie@nokia.com> | 2010-12-06 18:00:42 (GMT) |
| commit | 34bfad76d1afe4a0ee27496e740c8566387dc16c (patch) | |
| tree | c4304699a1a2d4a729bddfb3102a5ba3ad9a2cd8 /doc/src/declarative/codingconventions.qdoc | |
| parent | 16c3df54960b776f35f59288b888e829e7e81002 (diff) | |
| parent | 608b66b5af75ae6982be428439eea735c00cc455 (diff) | |
| download | Qt-34bfad76d1afe4a0ee27496e740c8566387dc16c.zip Qt-34bfad76d1afe4a0ee27496e740c8566387dc16c.tar.gz Qt-34bfad76d1afe4a0ee27496e740c8566387dc16c.tar.bz2 | |
Merge branch '4.7' of scm.dev.nokia.troll.no:qt/qt-doc-team into 4.7
Diffstat (limited to 'doc/src/declarative/codingconventions.qdoc')
| -rw-r--r-- | doc/src/declarative/codingconventions.qdoc | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/src/declarative/codingconventions.qdoc b/doc/src/declarative/codingconventions.qdoc index ba789e0..3f92d46 100644 --- a/doc/src/declarative/codingconventions.qdoc +++ b/doc/src/declarative/codingconventions.qdoc @@ -35,7 +35,7 @@ This page assumes that you are already familiar with the QML language. If you need an introduction to the language, please read \l {Introduction to the QML language}{the QML introduction} first. -\section1 QML objects +\section1 QML Objects Through our documentation and examples, QML objects are always structured in the following order: @@ -58,7 +58,7 @@ For example, a hypothetical \e photo QML object would look like this: \snippet doc/src/snippets/declarative/codingconventions/photo.qml 0 -\section1 Grouped properties +\section1 Grouped Properties If using multiple properties from a group of properties, we use the \e {group notation} rather than the \e {dot notation} to improve readability. @@ -72,6 +72,18 @@ can be written like this: \snippet doc/src/snippets/declarative/codingconventions/dotproperties.qml 1 +\section1 Private Properties + +QML and JavaScript do not enforce private properties like C++. There is a need +to hide these private properties, for example, when the properties are part of +the implementation. As a convention, private properties begin with two +\e underscore characters. For example, \c __area, is a property that is +accessible but is not meant for public use. Note that QML and JavaScript will +grant the user access to these properties. + +\snippet doc/src/snippets/declarative/codingconventions/private.qml 0 + + \section1 Lists If a list contains only one element, we generally omit the square brackets. @@ -87,7 +99,7 @@ we will write this: \snippet doc/src/snippets/declarative/codingconventions/lists.qml 1 -\section1 JavaScript code +\section1 JavaScript Code If the script is a single expression, we recommend writing it inline: |