MarkupOC 开源项目使用教程

MarkupOC 开源项目使用教程

MarkupOCMarkup is simple and useful Markup Language。it was wirtten by Js and widely used in web. We alse can use it in Native code, So we rewrite it by Objective C . When you write iOS App , you can think about it . 项目地址:https://gitcode.com/gh_mirrors/ma/MarkupOC

1. 项目的目录结构及介绍

MarkupOC/
├── README.md
├── src/
│   ├── main.cpp
│   ├── config.json
│   └── utils/
│       ├── logger.cpp
│       └── logger.h
├── include/
│   └── MarkupOC.h
├── tests/
│   └── test_main.cpp
└── docs/
    └── tutorial.md

• README.md: 项目介绍和基本使用说明。
• src/: 源代码目录。
  • main.cpp: 项目的主启动文件。
  • config.json: 项目的配置文件。
  • utils/: 工具类和函数。
• include/: 头文件目录。
• tests/: 测试代码目录。
• docs/: 项目文档目录。

2. 项目的启动文件介绍

src/main.cpp 是项目的启动文件，负责初始化项目并启动主程序。以下是 main.cpp 的基本结构：

#include "MarkupOC.h"

int main() {
    // 初始化配置
    Config config = loadConfig("config.json");
    
    // 启动主程序
    MarkupOC app(config);
    app.run();
    
    return 0;
}

• #include "MarkupOC.h": 引入项目的主头文件。
• loadConfig("config.json"): 加载配置文件。
• MarkupOC app(config): 初始化主程序。
• app.run(): 启动主程序。

3. 项目的配置文件介绍

src/config.json 是项目的配置文件，包含项目运行所需的各种配置参数。以下是 config.json 的基本结构：

{
    "logLevel": "info",
    "database": {
        "host": "localhost",
        "port": 3306,
        "user": "root",
        "password": "123456"
    },
    "server": {
        "port": 8080
    }
}

• logLevel: 日志级别，可选值为 debug, info, warning, error。
• database: 数据库配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
• server: 服务器配置。
  • port: 服务器监听端口。

MarkupOCMarkup is simple and useful Markup Language。it was wirtten by Js and widely used in web. We alse can use it in Native code, So we rewrite it by Objective C . When you write iOS App , you can think about it . 项目地址:https://gitcode.com/gh_mirrors/ma/MarkupOC