diff options
| author | Li Jin <dragon-fly@qq.com> | 2025-01-06 17:31:36 +0800 |
|---|---|---|
| committer | Li Jin <dragon-fly@qq.com> | 2025-01-06 17:31:36 +0800 |
| commit | ba511abf3c5eed23f4aef0fde0a3e6e0e8f3f41f (patch) | |
| tree | fa60531f63080c647431e6d5e0351b2bac36f024 /doc/docs/zh | |
| parent | e17183887d53f3ef8a39d14bcb6e55add8ca105b (diff) | |
| download | yuescript-ba511abf3c5eed23f4aef0fde0a3e6e0e8f3f41f.tar.gz yuescript-ba511abf3c5eed23f4aef0fde0a3e6e0e8f3f41f.tar.bz2 yuescript-ba511abf3c5eed23f4aef0fde0a3e6e0e8f3f41f.zip | |
Updated docs.
Diffstat (limited to 'doc/docs/zh')
| -rwxr-xr-x | doc/docs/zh/doc/README.md | 44 | ||||
| -rwxr-xr-x | doc/docs/zh/try/README.md | 2 |
2 files changed, 23 insertions, 23 deletions
diff --git a/doc/docs/zh/doc/README.md b/doc/docs/zh/doc/README.md index c9233f6..355e468 100755 --- a/doc/docs/zh/doc/README.md +++ b/doc/docs/zh/doc/README.md | |||
| @@ -9,7 +9,7 @@ title: 参考手册 | |||
| 9 | 9 | ||
| 10 | ## 介绍 | 10 | ## 介绍 |
| 11 | 11 | ||
| 12 | 月之脚本(Yuescript)是一种动态语言,可以编译为Lua。它是[Moonscript](https://github.com/leafo/moonscript)的方言。用月之脚本编写的代码既有表现力又非常简洁。它适合编写一些更易于维护的代码,并在嵌入 Lua 的环境中运行,如游戏或网站服务器。 | 12 | 月之脚本(YueScript)是一种动态语言,可以编译为Lua。它是[MoonScript](https://github.com/leafo/moonscript)的方言。用月之脚本编写的代码既有表现力又非常简洁。它适合编写一些更易于维护的代码,并在嵌入 Lua 的环境中运行,如游戏或网站服务器。 |
| 13 | 13 | ||
| 14 | Yue(月)是中文中“月亮”的名称。 | 14 | Yue(月)是中文中“月亮”的名称。 |
| 15 | 15 | ||
| @@ -3602,7 +3602,7 @@ yue_compiled: {string: string} | |||
| 3602 | 3602 | ||
| 3603 | **描述:** | 3603 | **描述:** |
| 3604 | 3604 | ||
| 3605 | 月之脚本的编译函数。它将 Yuescript 代码编译为 Lua 代码。 | 3605 | 月之脚本的编译函数。它将 YueScript 代码编译为 Lua 代码。 |
| 3606 | 3606 | ||
| 3607 | **签名:** | 3607 | **签名:** |
| 3608 | ```lua | 3608 | ```lua |
| @@ -3616,7 +3616,7 @@ to_lua: function(code: string, config?: Config): | |||
| 3616 | 3616 | ||
| 3617 | | 参数名 | 类型 | 描述 | | 3617 | | 参数名 | 类型 | 描述 | |
| 3618 | | --- | --- | --- | | 3618 | | --- | --- | --- | |
| 3619 | | code | string | Yuescript 代码。 | | 3619 | | code | string | YueScript 代码。 | |
| 3620 | | config | Config | [可选] 编译器选项。 | | 3620 | | config | Config | [可选] 编译器选项。 | |
| 3621 | 3621 | ||
| 3622 | **返回值:** | 3622 | **返回值:** |
| @@ -3683,7 +3683,7 @@ read_file: function(filename: string): string | |||
| 3683 | 3683 | ||
| 3684 | **描述:** | 3684 | **描述:** |
| 3685 | 3685 | ||
| 3686 | 将 Yuescript 加载器插入到 Lua 包加载器(搜索器)中。 | 3686 | 将 YueScript 加载器插入到 Lua 包加载器(搜索器)中。 |
| 3687 | 3687 | ||
| 3688 | **签名:** | 3688 | **签名:** |
| 3689 | ```lua | 3689 | ```lua |
| @@ -3708,7 +3708,7 @@ insert_loader: function(pos?: integer): boolean | |||
| 3708 | 3708 | ||
| 3709 | **描述:** | 3709 | **描述:** |
| 3710 | 3710 | ||
| 3711 | 从 Lua 包加载器(搜索器)中移除 Yuescript 加载器。 | 3711 | 从 Lua 包加载器(搜索器)中移除 YueScript 加载器。 |
| 3712 | 3712 | ||
| 3713 | **签名:** | 3713 | **签名:** |
| 3714 | ```lua | 3714 | ```lua |
| @@ -3727,7 +3727,7 @@ remove_loader: function(): boolean | |||
| 3727 | 3727 | ||
| 3728 | **描述:** | 3728 | **描述:** |
| 3729 | 3729 | ||
| 3730 | 将 Yuescript 代码字符串加载为一个函数。 | 3730 | 将 YueScript 代码字符串加载为一个函数。 |
| 3731 | 3731 | ||
| 3732 | **签名:** | 3732 | **签名:** |
| 3733 | ```lua | 3733 | ```lua |
| @@ -3740,7 +3740,7 @@ loadstring: function(input: string, chunkname: string, env: table, config?: Conf | |||
| 3740 | 3740 | ||
| 3741 | | 参数名 | 类型 | 描述 | | 3741 | | 参数名 | 类型 | 描述 | |
| 3742 | | --- | --- | --- | | 3742 | | --- | --- | --- | |
| 3743 | | input | string | Yuescript 代码。 | | 3743 | | input | string | YueScript 代码。 | |
| 3744 | | chunkname | string | 代码块的名称。 | | 3744 | | chunkname | string | 代码块的名称。 | |
| 3745 | | env | table | 环境表。 | | 3745 | | env | table | 环境表。 | |
| 3746 | | config | Config | [可选] 编译器选项。 | | 3746 | | config | Config | [可选] 编译器选项。 | |
| @@ -3758,7 +3758,7 @@ loadstring: function(input: string, chunkname: string, env: table, config?: Conf | |||
| 3758 | 3758 | ||
| 3759 | **描述:** | 3759 | **描述:** |
| 3760 | 3760 | ||
| 3761 | 将 Yuescript 代码字符串加载为一个函数。 | 3761 | 将 YueScript 代码字符串加载为一个函数。 |
| 3762 | 3762 | ||
| 3763 | **签名:** | 3763 | **签名:** |
| 3764 | ```lua | 3764 | ```lua |
| @@ -3771,7 +3771,7 @@ loadstring: function(input: string, chunkname: string, config?: Config): | |||
| 3771 | 3771 | ||
| 3772 | | 参数名 | 类型 | 描述 | | 3772 | | 参数名 | 类型 | 描述 | |
| 3773 | | --- | --- | --- | | 3773 | | --- | --- | --- | |
| 3774 | | input | string | Yuescript 代码。 | | 3774 | | input | string | YueScript 代码。 | |
| 3775 | | chunkname | string | 代码块的名称。 | | 3775 | | chunkname | string | 代码块的名称。 | |
| 3776 | | config | Config | [可选] 编译器选项。 | | 3776 | | config | Config | [可选] 编译器选项。 | |
| 3777 | 3777 | ||
| @@ -3788,7 +3788,7 @@ loadstring: function(input: string, chunkname: string, config?: Config): | |||
| 3788 | 3788 | ||
| 3789 | **描述:** | 3789 | **描述:** |
| 3790 | 3790 | ||
| 3791 | 将 Yuescript 代码字符串加载为一个函数。 | 3791 | 将 YueScript 代码字符串加载为一个函数。 |
| 3792 | 3792 | ||
| 3793 | **签名:** | 3793 | **签名:** |
| 3794 | ```lua | 3794 | ```lua |
| @@ -3801,7 +3801,7 @@ loadstring: function(input: string, config?: Config): | |||
| 3801 | 3801 | ||
| 3802 | | 参数名 | 类型 | 描述 | | 3802 | | 参数名 | 类型 | 描述 | |
| 3803 | | --- | --- | --- | | 3803 | | --- | --- | --- | |
| 3804 | | input | string | Yuescript 代码。 | | 3804 | | input | string | YueScript 代码。 | |
| 3805 | | config | Config | [可选] 编译器选项。 | | 3805 | | config | Config | [可选] 编译器选项。 | |
| 3806 | 3806 | ||
| 3807 | **返回值:** | 3807 | **返回值:** |
| @@ -3817,7 +3817,7 @@ loadstring: function(input: string, config?: Config): | |||
| 3817 | 3817 | ||
| 3818 | **描述:** | 3818 | **描述:** |
| 3819 | 3819 | ||
| 3820 | 将 Yuescript 代码文件加载为一个函数。 | 3820 | 将 YueScript 代码文件加载为一个函数。 |
| 3821 | 3821 | ||
| 3822 | **签名:** | 3822 | **签名:** |
| 3823 | ```lua | 3823 | ```lua |
| @@ -3847,7 +3847,7 @@ loadfile: function(filename: string, env: table, config?: Config): | |||
| 3847 | 3847 | ||
| 3848 | **描述:** | 3848 | **描述:** |
| 3849 | 3849 | ||
| 3850 | 将 Yuescript 代码文件加载为一个函数。 | 3850 | 将 YueScript 代码文件加载为一个函数。 |
| 3851 | 3851 | ||
| 3852 | **签名:** | 3852 | **签名:** |
| 3853 | ```lua | 3853 | ```lua |
| @@ -3876,7 +3876,7 @@ loadfile: function(filename: string, config?: Config): | |||
| 3876 | 3876 | ||
| 3877 | **描述:** | 3877 | **描述:** |
| 3878 | 3878 | ||
| 3879 | 将 Yuescript 代码文件加载为一个函数并执行。 | 3879 | 将 YueScript 代码文件加载为一个函数并执行。 |
| 3880 | 3880 | ||
| 3881 | **签名:** | 3881 | **签名:** |
| 3882 | ```lua | 3882 | ```lua |
| @@ -3903,7 +3903,7 @@ dofile: function(filename: string, env: table, config?: Config): any... | |||
| 3903 | 3903 | ||
| 3904 | **描述:** | 3904 | **描述:** |
| 3905 | 3905 | ||
| 3906 | 将 Yuescript 代码文件加载为一个函数并执行。 | 3906 | 将 YueScript 代码文件加载为一个函数并执行。 |
| 3907 | 3907 | ||
| 3908 | **签名:** | 3908 | **签名:** |
| 3909 | ```lua | 3909 | ```lua |
| @@ -3929,7 +3929,7 @@ dofile: function(filename: string, config?: Config): any... | |||
| 3929 | 3929 | ||
| 3930 | **描述:** | 3930 | **描述:** |
| 3931 | 3931 | ||
| 3932 | 将 Yuescript 模块名解析为文件路径。 | 3932 | 将 YueScript 模块名解析为文件路径。 |
| 3933 | 3933 | ||
| 3934 | **签名:** | 3934 | **签名:** |
| 3935 | ```lua | 3935 | ```lua |
| @@ -3956,7 +3956,7 @@ find_modulepath: function(name: string): string | |||
| 3956 | 3956 | ||
| 3957 | 在保护模式下调用一个函数。 | 3957 | 在保护模式下调用一个函数。 |
| 3958 | 会捕获任何错误,执行成功则返回成功状态和结果,否则为失败状态和错误信息。 | 3958 | 会捕获任何错误,执行成功则返回成功状态和结果,否则为失败状态和错误信息。 |
| 3959 | 当发生错误时,将错误信息中的代码行号重写为 Yuescript 代码中的原始行号。 | 3959 | 当发生错误时,将错误信息中的代码行号重写为 YueScript 代码中的原始行号。 |
| 3960 | 3960 | ||
| 3961 | **签名:** | 3961 | **签名:** |
| 3962 | ```lua | 3962 | ```lua |
| @@ -3982,8 +3982,8 @@ pcall: function(f: function, ...: any): boolean, any... | |||
| 3982 | 3982 | ||
| 3983 | **描述:** | 3983 | **描述:** |
| 3984 | 3984 | ||
| 3985 | 加载给定的模块。可以是 Lua 模块或 Yuescript 模块。 | 3985 | 加载给定的模块。可以是 Lua 模块或 YueScript 模块。 |
| 3986 | 如果模块是 Yuescript 模块且加载失败,则将错误信息中的代码行号重写为 Yuescript 代码中的原始行号。 | 3986 | 如果模块是 YueScript 模块且加载失败,则将错误信息中的代码行号重写为 YueScript 代码中的原始行号。 |
| 3987 | 3987 | ||
| 3988 | **签名:** | 3988 | **签名:** |
| 3989 | ```lua | 3989 | ```lua |
| @@ -4040,7 +4040,7 @@ options: Config.Options | |||
| 4040 | 4040 | ||
| 4041 | **描述:** | 4041 | **描述:** |
| 4042 | 4042 | ||
| 4043 | 重写堆栈跟踪中的行号为 Yuescript 代码中的原始行号的 traceback 函数。 | 4043 | 重写堆栈跟踪中的行号为 YueScript 代码中的原始行号的 traceback 函数。 |
| 4044 | 4044 | ||
| 4045 | **签名:** | 4045 | **签名:** |
| 4046 | ```lua | 4046 | ```lua |
| @@ -4126,8 +4126,8 @@ to_ast: function(code: string, flattenLevel?: number, astName?: string): | |||
| 4126 | 4126 | ||
| 4127 | **描述:** | 4127 | **描述:** |
| 4128 | 4128 | ||
| 4129 | 导入 Yuescript 模块。 | 4129 | 导入 YueScript 模块。 |
| 4130 | 如果发生加载失败,则将错误信息中的代码行号重写为 Yuescript 代码中的原始行号。 | 4130 | 如果发生加载失败,则将错误信息中的代码行号重写为 YueScript 代码中的原始行号。 |
| 4131 | 4131 | ||
| 4132 | **签名:** | 4132 | **签名:** |
| 4133 | ```lua | 4133 | ```lua |
diff --git a/doc/docs/zh/try/README.md b/doc/docs/zh/try/README.md index c42e5a9..46667a8 100755 --- a/doc/docs/zh/try/README.md +++ b/doc/docs/zh/try/README.md | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | # 月之脚本的在线编译器 | 1 | # 月之脚本的在线编译器 |
| 2 | --- | 2 | --- |
| 3 | 3 | ||
| 4 | 在这里试试 WASM 版的 Yuescript 吧。 | 4 | 在这里试试 WASM 版的 YueScript 吧。 |
| 5 | 5 | ||
| 6 | <YueCompiler /> | 6 | <YueCompiler /> |
