mirror of https://github.com/motajs/template.git synced 2026-10-19 05:10:16 +08:00

unanmed c47aa5269b docs(10-02): write code-basics and hooks concept docs

- code-basics: concise syntax, modules/imports, types intro (generics as
  'functions of types'), interface/implements convention, approved external link
- hooks: what hooks are, common hook families, need-to-hook table, addHook/
  removeHook usage, async hooks

2026-10-17 17:49:49 +08:00

3.4 KiB

Raw Blame History

代码基础

即使你只懂一点代码，也能读懂并编写本引擎的大部分内容。本篇用尽量简短的方式，补齐写中级教程所需的最小语法与类型知识。如果你已有 JavaScript / TypeScript 基础，可以快速跳过对应小节。

一、简明语法

变量

// let 声明之后可以重新赋值的变量
let count = 0;

// const 声明之后不再重新赋值的变量
const name = 'hero';

count = count + 1;

函数

// 函数接收参数，返回结果
function add(a: number, b: number): number {
    return a + b;
}

// 箭头函数是函数的简写形式
const double = (n: number) => n * 2;

分支与循环

if (count > 0) {
    // 条件成立时执行
} else {
    // 条件不成立时执行
}

for (const item of items) {
    // 逐个处理 items 中的每一项
}

对象与数组

// 对象：一组有名字的字段
const hero = { hp: 100, atk: 10 };

// 数组：一串有序的值
const skills = ['a', 'b', 'c'];

hero.atk = hero.atk + 5;

二、模块与引入

一个文件就是一个模块。用 export 把内容暴露出去，用 import 从别的模块引入。在本引擎里，文件顶部的 import 必须紧挨在一起，中间不夹注释或空行。

// math.ts
export function add(a: number, b: number): number {
    return a + b;
}

export const PI = 3.14;

// main.ts
import { add, PI } from './math';

add(1, PI);

也可以整体引入：

import * as math from './math';

math.add(1, 2);

三、类型入门

TypeScript 在 JavaScript 之上增加了类型，用来描述「这份数据长什么样」。类型会在编写与编译阶段被检查，帮助你在运行之前就发现错误。

基础类型

let n: number = 1;
let s: string = 'text';
let b: boolean = true;

接口

当一份对象有固定的形状时，用 interface 描述它。声明好接口之后，就可以把一个符合该形状的对象标注为这个类型。

interface Hero {
    hp: number;
    atk: number;
}

const hero: Hero = { hp: 100, atk: 10 };

泛型：类型的「函数」

普通函数接收值、返回值；泛型则接收类型、返回类型，可以把它理解成「类型的函数」。尖括号里的 T 是一个类型参数，调用时才确定具体是什么类型。

// T 是类型参数，取什么类型由调用时传入的值决定
function first<T>(list: T[]): T {
    return list[0];
}

const a = first([1, 2, 3]); // T 被推断为 number，a 的类型是 number
const b = first(['x', 'y']); // T 被推断为 string，b 的类型是 string

接口与实现：一种约定

本引擎大量使用 interface 描述接口，再让类去 implements 它，以此保证类实现了接口要求的所有内容。

interface Runner {
    run(): void;
}

class FastRunner implements Runner {
    run(): void {
        // 具体实现
    }
}

这是一种建议但非强制的约定：遵循它能让代码结构更清晰、类型更可靠；不遵循也不会导致程序出错。

进一步学习

本篇只覆盖了编写本引擎所需的最小语法。如果你想系统学习 JavaScript / TypeScript，下面这份教程更适合本引擎的作者：

JavaScript / TypeScript 教程

写代码时该把文件放到哪里，见 src 导览。

3.4 KiB Raw Blame History Unescape Escape