Ooui 项目教程

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

Ooui 项目的目录结构如下：

Ooui/
├── Documentation/
│   ├── Ooui.AspNetCore/
│   ├── Ooui.Forms/
│   ├── Ooui.Wasm/
│   └── Ooui.Wasm.Build.Tasks/
├── PlatformSamples/
│   └── AspNetCoreMvc/
├── PlatformTests/
├── Samples/
├── Tests/
├── .editorconfig
├── .gitignore
├── .gitmodules
├── LICENSE
├── Ooui.sln
└── README.md

目录结构介绍

• Documentation/: 包含项目的文档，分为不同的子目录，如 Ooui.AspNetCore、Ooui.Forms、Ooui.Wasm 和 Ooui.Wasm.Build.Tasks。
• PlatformSamples/: 包含平台示例，如 AspNetCoreMvc。
• PlatformTests/: 包含平台测试代码。
• Samples/: 包含项目的示例代码。
• Tests/: 包含项目的测试代码。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• LICENSE: 项目许可证文件。
• Ooui.sln: 项目的解决方案文件。
• README.md: 项目的自述文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 Samples/ 目录下。以下是一个典型的启动文件示例：

using System;
using Ooui;

class Program
{
    static void Main(string[] args)
    {
        // 创建 UI
        var button = new Button("Click me!");

        // 添加一些逻辑
        var count = 0;
        button.Click += (s, e) =>
        {
            count++;
            button.Text = $"Clicked {count} times";
        };

        // 发布对象使其在给定的 URL 上可用
        // 用户应被引导到 http://localhost:8080/shared-button
        UI.Publish("/shared-button", button);

        // 不要在有人按下回车键之前退出应用程序
        Console.ReadLine();
    }
}

启动文件介绍

• Main 方法: 这是应用程序的入口点。在这个方法中，我们创建了一个按钮，并为其添加了点击事件处理逻辑。
• UI.Publish 方法: 该方法将按钮发布到指定的 URL，使得用户可以通过浏览器访问并与之交互。
• Console.ReadLine 方法: 该方法用于阻止应用程序在用户按下回车键之前退出。

3. 项目的配置文件介绍

项目的配置文件主要包括 .editorconfig、.gitignore、.gitmodules 和 Ooui.sln。

.editorconfig

.editorconfig 文件用于定义项目的编码风格和格式化规则，确保不同开发者之间的代码风格一致。

.gitignore

.gitignore 文件用于指定 Git 应该忽略的文件和目录，避免将不必要的文件提交到版本控制系统中。

.gitmodules

.gitmodules 文件用于管理 Git 子模块，指定项目中使用的子模块及其对应的仓库地址。

Ooui.sln

Ooui.sln 是项目的解决方案文件，包含了项目中所有的项目文件和配置信息。通过该文件，开发者可以在 Visual Studio 或其他支持 .sln 文件的 IDE 中打开并管理整个项目。

总结

通过本教程，您了解了 Ooui 项目的目录结构、启动文件和配置文件的基本信息。希望这些内容能帮助您更好地理解和使用 Ooui 项目。