Adding snippet code to coding article.

Task-number: QTBUG-16071

1 files changed, 57 insertions, 48 deletions

diff --git a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
index 6c83c80..e33ee13 100644
--- a/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
+++ b/doc/src/howtos/qmlbestpractices/qmlbestpractices-coding.qdoc
@@ -26,69 +26,78 @@
 ****************************************************************************/
 
 /*!
-    \page qml-best-practices-coding.html
-    \ingroup qml-best-practices
-    \contentspage QML Best Practices Guides
-    \previouspage QML Best Practices Guides
-    \startpage QML Best Practices Guides
-    \title QML Best Practices: Coding Conventions
+\page qml-best-practices-coding.html
+\ingroup qml-best-practices
+\contentspage QML Best Practices Guides
+\previouspage QML Best Practices Guides
+\startpage QML Best Practices Guides
+\title QML Best Practices: Coding Conventions
 
-    \brief QML Coding Conventions and Importing Files
+\brief QML Coding Conventions and Importing Files
 
-    There are many different ways to code using QML. These are a set of
-    guidelines to help your code look better and consistent.
+There are many different ways to code using QML. These are a set of
+guidelines to help your code look better and consistent.
 
-    \section1 Coding Conventions
+\section1 Coding Conventions
 
-    The official QML Coding Conventions may be found at
-    \l {QML Coding Conventions}. This is the recommended convention that will be
-    used throughout the QML documentation.
+The official QML Coding Conventions may be found at
+\l {QML Coding Conventions}. This is the recommended convention that will be
+used throughout the QML documentation.
 
-    In addition, Qt's official code style may be found at the \l {Qt Coding Style}.
+In addition, Qt's official code style may be found at the \l {Qt Coding Style}.
 
-    \section1 Importing Files into QML
+\section1 Importing Files into QML
 
-    To import items such as directories, use the "import" keyword, similar to
-    the way the \c {import QtQuick 1.0} statement is used.
+To import items such as directories, use the "import" keyword, similar to
+the way the \c {import QtQuick 1.0} statement is used.
 
-    \qml
-    import QtQuick 1.0
-    import QtWebKit 1.0
-    import "subdirectory"
-    import "script.js"
-    \endqml
+\qml
+import QtQuick 1.0
+import QtWebKit 1.0
+import "subdirectory"
+import "script.js"
+\endqml
 
-    To facilitate the importation of QML components, it is best to begin the QML
-    file with an uppercase character. This way, the user can simply declare the
-    component using the file name as the component name. For example, if a QML
-    component is in a file named \c Button.qml, then the user may import the
-    component by declaring a \c {Button {}}. Note that this method only works if
-    the QML files are in the same directory.
+To facilitate the importation of QML components, it is best to begin the QML
+file with an uppercase character. This way, the user can simply declare the
+component using the file name as the component name. For example, if a QML
+component is in a file named \c Button.qml, then the user may import the
+component by declaring a \c {Button {}}. Note that this method only works if
+the QML files are in the same directory.
 
-    \qml
-    import QtQuick 1.0
+It is also possible to import QML files which have file names that begin in
+lower case or files in a different directory by using a \c qmldir file.
 
-    Rectangle {
-        width: 50; height: 50
+A \c qmldir file tells your QML application which QML components, plugins,
+or directories to import. The \c qmldir file must reside in an imported
+directory. By using the \c qmldir file, users may import any QML file and assign any
+valid QML component name to the component.
 
-        Button {}   //Button is defined in Button.qml in the same directory
-    }
-    \endqml
+For more information, read the section on
+\l{qml-loading-components}{Loading a Component}.
 
-    It is also possible to import QML files which have file names that begin in
-    lower case or files in a different directory by using a \c qmldir file.
+\section1 Commenting Code
 
-    A \c qmldir file tells your QML application which QML components, plugins,
-    or directories to import. The \c qmldir file must reside in an imported
-    directory.
+Commenting code allows others to read the source code better. As well, comments
+allow the programmer to think about his or her code; a confusing comment may
+mean the code is confusing.
 
-    \code
-    //A very simple qmldir file
+Similar to JavaScript or C++, there are two ways of commenting QML code:
+\list
+\o Single line comments start with \c{//} and finish at the end of the line
+\o Multiline comments start with \c{/*} and finish with *\/
+\endlist
 
-    Button ./custom.qml         //a QML component called Button in the file custom.qml
-    plugin FilePlugin ./plugins //a plugin called FileDialog in the plugins directory
-    \endcode
+\section1 Group Properties
+
+Many QML properties are \l{attached-properties}{attached} or
+\l {qml-grouped-properties}{group} properties. For convenience, you may treat
+them as another element when dealing with multiple properties belonging to the
+same group.
+
+\snippet doc/src/snippets/declarative/bestpractices/group.qml not grouped
+Treating groups of properties as a block can ease confusion and help relate the
+properties with other properties.
+\snippet doc/src/snippets/declarative/bestpractices/group.qml grouped
 
-    By using the \c qmldir file, users may import any QML file and assign any
-    valid QML component name to the component.
 */