Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.

Qt6/Example-Guideline: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 14: Line 14:
* Use qmllint for qml code: https://doc-snapshots.qt.io/qt6-dev/qtquick-tool-qmllint.html
* Use qmllint for qml code: https://doc-snapshots.qt.io/qt6-dev/qtquick-tool-qmllint.html
* Enable compiler warnings and check if the reported issues are fixable with meaningful effort.   
* Enable compiler warnings and check if the reported issues are fixable with meaningful effort.   


'''RECOMMENDED'''
'''RECOMMENDED'''
Consider also the compilation with the more strict warning flags and fix the found issues.
Consider also the compilation with the more strict warning flags and fix the found issues.



Revision as of 08:56, 17 January 2023

When creating or updating Qt examples, developer should consider the best practises and guidelines listed in this document.

Evaluate if the example is meaningful or should it be removed/merged

MANDATORY

  • Check if there are similar examples for the same topic and consider if both are really needed or should the other one be merged with the other.
  • Check also documentation on the topic and if that includes inline code snippet that would be adequate instead of complete example.

No C++ or qml warnings

MANDATORY


RECOMMENDED

Consider also the compilation with the more strict warning flags and fix the found issues.

GCC

Clang

Visual Studio