1.1 项目注释

(1)CMakeLists.txt 注释模板

# ============================================================
# 项目名称: YourProjectName
# 版本: 1.0.0
# 作者: Your Name
# 创建日期: YYYY-MM-DD
# 项目简介: 
#   这是一个基于 Qt6 和 Qt Quick 的应用程序,主要用于...
# ============================================================
cmake_minimum_required(VERSION 3.16)

# 配置项目
project(YourProjectName VERSION 1.0 LANGUAGES CXX)

(2)main.cpp 注释模板

/*
 * ============================================================
 * 文件名: main.cpp
 * 说明:
 *   这是应用程序的主入口点。
 * 功能:
 *   1. 初始化应用程序。
 *   2. 设置 QML 引擎。
 *   3. 注册 C++ 模块到 QML。
 *   4. 加载主界面。
 * 作者: Your Name
 * 创建日期: YYYY-MM-DD
 * ============================================================
 */

#include <QGuiApplication>
#include <QQmlApplicationEngine>
#include <QSqlDatabase>
#include <QSqlError>
#include <QQmlContext>

// 注册模块等代码...
int main(int argc, char *argv[]) {
    // 应用程序初始化
    QGuiApplication app(argc, argv);

    // QML 引擎配置
    QQmlApplicationEngine engine;

    // 导入路径配置
    engine.addImportPath("qrc:/");

    // 加载主界面
    engine.load(QUrl(u"qrc:/Main.qml"_qs));

    if (engine.rootObjects().isEmpty())
        return -1;

    return app.exec();
}

(3)Main.qml 注释模板

(4)自定义类注释模板

(5)资源文件注释模板

最后更新于