doc: 修复文档错误，$ 必须转义，否则可能无法正确显示

framework/doc.tin

@@ -39,11 +39,11 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //    具体来说，假设文件名是 foo/bar.tin，则本命令会从以下位置按照从上到下的顺序进行查找：
 //
 //      - 1. 玩家自定义位置: var/foo/bar.tin
-//      - 2. MUD定制版位置:  mud/$MUD/foo/bar.tin
+//      - 2. MUD定制版位置:  mud/\$MUD/foo/bar.tin
 //      - 3. 默认脚本位置:   foo/bar.tin
 //
 //    如果前面的某个位置找到了相应的文件，则不再继续查找。
-//    其中 $MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
+//    其中 \$MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
 //
 //    这意味着，PaoTin++ 框架下所有的文件 TinTin++ 脚本，都支持重载机制，也就是说允许
 //    用户修改。但是要注意，用户必须在修改之前，将其拷贝一份副本，放置在 var 目录下，
@@ -51,7 +51,7 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    另外，除了文件的覆盖式重载机制之外，PaoTin++ 还提供了一种文件的继承式修改机制。
 //    即：对于 foo/bar.tin 来说，不论最终加载的是前述哪个路径，加载之后，如果发现存在
-//    mud/$MUD/foo/bar.extra.tin，或者 var/foo/bar.extra.tin，则它们将会在 foo/bar.tin
+//    mud/\$MUD/foo/bar.extra.tin，或者 var/foo/bar.extra.tin，则它们将会在 foo/bar.tin
 //    加载后，进行补充式加载。最终加载结果类似于将上述文件的内容合并在一起之后加载。
 //
 // ## load-config <配置文件名>
@@ -59,11 +59,11 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //    也就是说，配置文件 foo/bar 对应的实际物理文件可能是：
 //
 //      - 1. 玩家自定义位置: var/etc/foo/bar.tin
-//      - 2. MUD定制版位置:  mud/$MUD/etc/foo/bar.tin
+//      - 2. MUD定制版位置:  mud/\$MUD/etc/foo/bar.tin
 //      - 3. 默认脚本位置:   etc/foo/bar.tin
 //
 //    如果前面的某个位置找到了相应的文件，则不再继续查找。
-//    其中 $MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
+//    其中 \$MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
 //
 // ## VAR <变量中文含义> <变量名> <值>
 //    声明并初始化变量。和 #var 不同，如果该变量已存在，则不会修改它的值。
@@ -243,10 +243,10 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //        以下是一些合格的变量名称举例：
 //
-//          * $gCurrentMUDLIB，全局变量，该变量可以从任何地方访问。
-//          * $fullsk.current-skill，模块全局变量，该变量仅供 fullsk 模块内部使用。
-//          * $fullsk.lingwu.skill，定义块全局变量，该变量仅供 fullsk.lingwu 别名及其次级块使用。
-//          * $name 局部变量，可能是什么东西的名字，仅可在代码块内访问，离开该代码块则失效。
+//          * \$gCurrentMUDLIB，全局变量，该变量可以从任何地方访问。
+//          * \$fullsk.current-skill，模块全局变量，该变量仅供 fullsk 模块内部使用。
+//          * \$fullsk.lingwu.skill，定义块全局变量，该变量仅供 fullsk.lingwu 别名及其次级块使用。
+//          * \$name 局部变量，可能是什么东西的名字，仅可在代码块内访问，离开该代码块则失效。
 //
 //     4. #class 命名规范
 //
@@ -277,11 +277,11 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //        一个 PaoTin++ 模块在磁盘上可以对应一个文件，或者对应一个目录。为了便于用户扩展，PaoTin++ 框架
 //        提供了三个不同的位置来加载模块，它们分别是：
 //
-//        - 默认位置:         $PaoTinRoot/plugins/              优先级最低，由 PaoTin++ 维护
-//        - MUD定制版位置:    $PaoTinRoot/mud/$MUD/plugins/     优先级居中，由 PaoTin++ 维护
-//        - 玩家自定义位置:   $PaoTinRoot/var/plugins/          优先级最高，由用户自行维护
+//        - 默认位置:         \$PaoTinRoot/plugins/              优先级最低，由 PaoTin++ 维护
+//        - MUD定制版位置:    \$PaoTinRoot/mud/\$MUD/plugins/     优先级居中，由 PaoTin++ 维护
+//        - 玩家自定义位置:   \$PaoTinRoot/var/plugins/          优先级最高，由用户自行维护
 //
-//        其中 $PaoTinRoot 代表 PaoTin++ 的安装目录，$MUD 代表 MUDLIB 的类型 ID。
+//        其中 \$PaoTinRoot 代表 PaoTin++ 的安装目录，\$MUD 代表 MUDLIB 的类型 ID。
 //        PaoTin++ 的模块应当存放在以上位置其中之一。模块全限定名的各个部分就相当于一个多级目录结构，
 //        这样所有的 PaoTin++ 模块就会形成三棵目录树，并在加载后从逻辑上来说位于同一个树状名字空间当中。
 //
@@ -304,17 +304,17 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //    也就是说，模块 foo/bar 对应的实际物理文件可能是：
 //
 //      - 1. 玩家自定义位置: var/plugins/foo/bar.tin
-//      - 2. MUD定制版位置:  mud/$MUD/plugins/foo/bar.tin
+//      - 2. MUD定制版位置:  mud/\$MUD/plugins/foo/bar.tin
 //      - 3. 默认脚本位置:   plugins/foo/bar.tin
 //      - 4. 玩家自定义位置: var/plugins/foo/bar/__init__.tin
-//      - 5. MUD定制版位置:  mud/$MUD/plugins/foo/bar/__init__.tin
+//      - 5. MUD定制版位置:  mud/\$MUD/plugins/foo/bar/__init__.tin
 //      - 6. 默认脚本位置:   plugins/foo/bar/__init__.tin
 //      - 7. 玩家自定义位置: var/plugins/foo/bar/__main__.tin
-//      - 8. MUD定制版位置:  mud/$MUD/plugins/foo/bar/__main__.tin
+//      - 8. MUD定制版位置:  mud/\$MUD/plugins/foo/bar/__main__.tin
 //      - 9. 默认脚本位置:   plugins/foo/bar/__main__.tin
 //
 //    如果前面的某个位置找到了相应的文件，则不再继续查找。
-//    其中 $MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
+//    其中 \$MUD 代表当前选择的游戏服务器，可通过 #var gCurrentMUDLIB 查看。
 //
 ///// 日志系统
 /////

plugins/lib/xtintin/algo.tin

@@ -76,10 +76,10 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //                     |经  英  城  惊  生  轻  嬴  横  名  行  星  明    |
 //                     |。  。  。  。  。  。  。  。  。  。  。  。    |};
 //
-//        #local lines {\@algo.ParseVertLayout{$vert}};
+//        #local lines {\@algo.ParseVertLayout{\$vert}};
 //        #local lineNo {};
 //        #foreach {*lines[]} {lineNo} {
-//            #echo {%s} {$lines[$lineNo]};
+//            #echo {%s} {\$lines[\$lineNo]};
 //        };
 //
 //    OUTPUT:

plugins/lib/xtintin/cmds.tin

@@ -388,7 +388,7 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 ///=== {
 // ## xtt.Var <变量中文含义> <变量名> <值>
 //    声明并初始化变量。和 #var 不同，如果该变量已存在，则不会修改它的值。
-//    另外，如果在模块中使用本方法，则声明的变量会自动存放在 #class data/$MODULE 中。
+//    另外，如果在模块中使用本方法，则声明的变量会自动存放在 #class data/\$MODULE 中。
 //    这意味着即使你重新载入模块代码，也不会破坏该变量的值。
 //    因此建议将通过触发抓取到的任务进度信息用本方法存储，可以有效避免机器代码迭代
 //    开发过程中，丢失任务信息从而导致任务失败。

plugins/lib/xtintin/default.tin

@@ -99,8 +99,8 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 // #@ defaultNumVar <字符串> <默认值>
 //    判断参数是否不像是一个数字，或者变量展开失败。如果是则返回默认值。
 //
-///// 由于 TinTin++ 的变量展开有个特点，那就是如果不存在变量 foo，则 $foo 展开的
-///// 结果并不是空字符串，而是字符串 "$foo"，会导致误以为不是空串。
+///// 由于 TinTin++ 的变量展开有个特点，那就是如果不存在变量 foo，则 \$foo 展开的
+///// 结果并不是空字符串，而是字符串 "\$foo"，会导致误以为不是空串。
 ///// 以上三个函数将该情形也视同为空字符串并做相应处理。
 // };
 #func {defaultNumVar} {

plugins/lib/xtintin/set.tin

@@ -36,9 +36,9 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //    EXAMPLE:
 //      #local list {};
 //      #list list {create} {h;e;l;l;o};
-//      #local set {\@set.FromList{$list}};
+//      #local set {\@set.FromList{\$list}};
 //
-//    ASSERT: {$set} === {{1}{h}{2}{e}{3}{l}{4}{o}}
+//    ASSERT: {\$set} === {{1}{h}{2}{e}{3}{l}{4}{o}}
 // };
 #func {set.FromList} {
     #local list {%0};
@@ -51,9 +51,9 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    EXAMPLE:
 //      #local set {\@set.Create{h;e;l;l;o}};
-//      #local size {\@set.Size{$set}};
+//      #local size {\@set.Size{\$set}};
 //
-//    ASSERT: {$size} === {4}
+//    ASSERT: {\$size} === {4}
 // };
 #func {set.Size} {
     #local set {%0};
@@ -93,15 +93,15 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    EXAMPLE:
 //      #local set {};
-//      #local set {\@set.Add{{$set}; a}};
-//      #local set {\@set.Add{{$set}; b; c}};
+//      #local set {\@set.Add{{\$set}; a}};
+//      #local set {\@set.Add{{\$set}; b; c}};
 //      #nop 注意：因为是集合，所以重复元素不再添加;
-//      #local set {\@set.Add{{$set}; a; b; c}};
-//      #local set {\@set.Add{{$set}; x; y; z}};
+//      #local set {\@set.Add{{\$set}; a; b; c}};
+//      #local set {\@set.Add{{\$set}; x; y; z}};
 //      #nop 注意：这里也有个重复的 l，只会被添加一次;
-//      #local set {\@set.Add{{$set}; h; e; l; l; o}};
+//      #local set {\@set.Add{{\$set}; h; e; l; l; o}};
 //
-//    ASSERT: {$set} === {{1}{a}{2}{b}{3}{c}{4}{x}{5}{y}{6}{z}{7}{h}{8}{e}{9}{l}{10}{o}}
+//    ASSERT: {\$set} === {{1}{a}{2}{b}{3}{c}{4}{x}{5}{y}{6}{z}{7}{h}{8}{e}{9}{l}{10}{o}}
 // };
 #func {set.Add} {
     #info arguments save;
@@ -130,9 +130,9 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    EXAMPLE:
 //      #local set {\@set.Create{a;b;c;d;e}};
-//      #local set {\@set.Remove{{$set};b;c;x;y;x}};
+//      #local set {\@set.Remove{{\$set};b;c;x;y;x}};
 //
-//    ASSERT: {$set} === {{1}{a}{2}{d}{3}{e}}
+//    ASSERT: {\$set} === {{1}{a}{2}{d}{3}{e}}
 // };
 #func {set.Remove} {
     #info arguments save;
@@ -164,12 +164,12 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //    EXAMPLE:
 //      #local set1 {\@set.Create{a;b;c}};
 //      #local set2 {};
-//      #local set2 {\@set.Add{{$set2};a}};
-//      #local set2 {\@set.Add{{$set2};b}};
-//      #local set2 {\@set.Add{{$set2};c}};
-//      #local ok {\@set.Equal{{$set1};{$set2}}};
+//      #local set2 {\@set.Add{{\$set2};a}};
+//      #local set2 {\@set.Add{{\$set2};b}};
+//      #local set2 {\@set.Add{{\$set2};c}};
+//      #local ok {\@set.Equal{{\$set1};{\$set2}}};
 //
-//    ASSERT: {$ok} === {1}
+//    ASSERT: {\$ok} === {1}
 // };
 #func {set.Equal} {
     #local set1  {%1};
@@ -539,15 +539,15 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    EXAMPLE:
 //      #local set {};
-//      #local set {\@sset.Add{{$set}; a}};
-//      #local set {\@sset.Add{{$set}; b; c}};
+//      #local set {\@sset.Add{{\$set}; a}};
+//      #local set {\@sset.Add{{\$set}; b; c}};
 //      #nop 注意：因为是集合，所以重复元素不再添加;
-//      #local set {\@sset.Add{{$set}; a; b; c}};
-//      #local set {\@sset.Add{{$set}; x; y; z}};
+//      #local set {\@sset.Add{{\$set}; a; b; c}};
+//      #local set {\@sset.Add{{\$set}; x; y; z}};
 //      #nop 注意：这里也有个重复的 l，只会被添加一次;
-//      #local set {\@sset.Add{{$set}; h; e; l; l; o}};
+//      #local set {\@sset.Add{{\$set}; h; e; l; l; o}};
 //
-//    ASSERT: {$set} === {a;b;c;x;y;z;h;e;l;o}
+//    ASSERT: {\$set} === {a;b;c;x;y;z;h;e;l;o}
 //
 // } ;
 #func {sset.Add} {
@@ -569,10 +569,10 @@ PaoTin++ © 2020~2023 的所有版权均由担子炮(dzp <danzipao@gmail.com>)
 //
 //    EXAMPLE:
 //      #local set {\@sset.Create{h;e;l;l;o;a;b;c;d}};
-//      #local set {\@sset.Remove{{$set};a;b}};
-//      #local set {\@sset.Remove{{$set};h;l;o}};
-//      #local set {\@sset.Remove{{$set};x;y}};
-//      #if { \@sset.Equal{{$set};{c;d;e}} } {
+//      #local set {\@sset.Remove{{\$set};a;b}};
+//      #local set {\@sset.Remove{{\$set};h;l;o}};
+//      #local set {\@sset.Remove{{\$set};x;y}};
+//      #if { \@sset.Equal{{\$set};{c;d;e}} } {
 //          #echo OK;
 //      };
 //