diff --git a/HowToUseXericLibrary.md b/HowToUseXericLibrary.md index 71767ba..a914fae 100644 --- a/HowToUseXericLibrary.md +++ b/HowToUseXericLibrary.md @@ -231,8 +231,8 @@ KeyCode.A.AsKfsStyle(); * Join: 将当前迭代器加入到字符串,可以设置如何开头,结尾,成员分割符。 * Merge: 将当前迭代器合并,可以实现类似sum的操作。 * EqualitySet: 比较两个迭代器里的成员是否相等。 -* Shift: 偏移列表,也可以使用`RingShift,CyclicShift`循环偏移。 -* 包含针对`IList>的Add,TryAdd,AddUnique,Remove,Modify,Contains,IndexOf,GetValue,GetKey,GetKeys,GetValues`方法。 +* Shift: 偏移列表,也可以使用`RingShift`,`CyclicShift`循环偏移。 +* 包含针对`IList>`的`Add`,`TryAdd`,`AddUnique`,`Remove`,`Modify`,`Contains`,`IndexOf`,`GetValue`,`GetKey`,`GetKeys`,`GetValues`方法。 * BinarySearch: 二分法遍历 * FindClosestIndexByBinarySearch: 基于浮点数的二分法查找方法。 * IsIndexGreaterZeroLessCount: @@ -251,7 +251,7 @@ KeyCode.A.AsKfsStyle(); * 全局业务分发器,消息入口Entry。 - 特点是需要通过指定消息入口(`RedirectReceiverMessage)和出口(RedirectReceiver`)来中转消息。 + 特点是需要通过指定消息入口(`RedirectReceiverMessage`)和出口(`RedirectReceiver`)来中转消息。 完成后消息发送时会被进行一次包装,将带有入口名称的内容一同发送;而在消息处理的另一端,也需要用相同的逻辑处理这个包,就能获得这个包来自哪,并自动定位到对应的预定义委托上进行处理。 下面是一个接收示例: ``` @@ -288,7 +288,7 @@ KeyCode.A.AsKfsStyle(); ``` * 方法封装器 - 提供一个方法软引用封装器,首先需要将一个可执行流程转换为`CallableTarget对象。然后通过AddCallableFunction添加到全局字典中,随后可以通过TryEvocation或者Evocation`调用。 + 提供一个方法软引用封装器,首先需要将一个可执行流程转换为`CallableTarget`对象。然后通过`AddCallableFunction`添加到全局字典中,随后可以通过`TryEvocation`或者`Evocation`调用。 方法封装器默认可以搜索所有静态,实例,私有,公共的方法 @@ -391,7 +391,7 @@ c#自带的排序很好用,但是选择何种排序模式是根据数据类型 ``` TextBlockBuilder 是所有blocker的基类,使用它包裹所有文本将起到单纯拼接文本的作用;TextBlockBuilder 里的三个block的作用是使用相应的富文本标签包裹,根据标签的类型,包裹器会自动决定标签格式。 `DelegateBlock`的作用是通过委托来实时获取一个变量,示例中直接获取value的文本值,拼接到结果中。 - TextBlockBuilder 可以不依靠如`DelegateBlock这样的包裹器,可以直接将返回字符串类型的方法委托传入,blocker 会自动识别;前提是开启对应 blocker 里的compatibility兼容性检查,但这会带来额外的性能开销,如果没有特别的需求,建议还是使用DelegateBlock`进行多态封装,这样也会更安全。 + TextBlockBuilder 可以不依靠如`DelegateBlock`这样的包裹器,可以直接将返回字符串类型的方法委托传入,blocker 会自动识别;前提是开启对应 blocker 里的`compatibility`兼容性检查,但这会带来额外的性能开销,如果没有特别的需求,建议还是使用`DelegateBlock`进行多态封装,这样也会更安全。 在新的更新中,包裹器支持域写法,同时可以省略部分参数: ``` @@ -414,10 +414,10 @@ c#自带的排序很好用,但是选择何种排序模式是根据数据类型 同时,委托包裹器并不是唯一设置动态参数的方式: * `SetParamters`:在根包裹器上使用赋值方法,可以将一系列值一一对应地填入到后续一系列包裹器中。 * `RefernceBlock`:反射包裹器允许传入一个对象,以及成员名称来访问属性 (字段,访问器,方法均可) 。 - * `ValueBlock:值包裹器,搭配SetParamters`来设置值,目标需要实现Tostring方法。 - * `NumberValueBlock数值类型包裹器,搭配SetParamters`来设置值,设置值会自动限制在最大最小范围内,如果给定的参数是字符串类型,将尝试通过默认的格式化方法转为数值。 + * `ValueBlock`:值包裹器,搭配`SetParamters`来设置值,目标需要实现Tostring方法。 + * `NumberValueBlock`数值类型包裹器,搭配`SetParamters`来设置值,设置值会自动限制在最大最小范围内,如果给定的参数是字符串类型,将尝试通过默认的格式化方法转为数值。 - 在实际使用时,只有`ValueBlock默认会从SetParamters`参数列表中获取值, + 在实际使用时,只有`ValueBlock`默认会从`SetParamters`参数列表中获取值, 其他包裹器需要手动通过`SetParameterization`参数化包裹器,否则不会响应参数列表。 值得时刻注意的是,`SetParamters`传递的值需要按深度优先的顺序逐一匹对,基本上可以认为是blockBuilder定义时的block先后顺序。 @@ -471,29 +471,30 @@ objects.Join(obj => obj.ToString(), "(", ")", ",") // 可以指定开头,结 包裹器可以依靠多态模型来构建文本,而不依赖字面量构建。下面是一个示例: ``` -// 下面这个包裹器等同于: 重量[value]kg +// 这个包裹器等同于: 重量1.23kg _blockBuilder = new TextBlockBuilder( new ColorBlock(Color.white, "重量"), - new DelegateBlock(() => value.ToString()), + new NumberValueBlock(1.23), new SizeBlock(20, "kg"))); ``` -TextBlockBuilder 是所有blocker的基类,使用它包裹所有文本将起到单纯拼接文本的作用TextBlockBuilder 里的三个block的作用是使用相应的富文本标签包裹,根据标签的类型,包裹器会自动决定标格式。 +TextBlockBuilder 是所有blocker的基类,使用它包裹所有文本将起到单纯拼接文本的作用,TextBlockBuilder里的三个block的作用是使用相应的富文本标签包裹,根据标签的类型,包裹器会自动决定标格式。 +这里由于最外层没有要展现的标签,所以直接使用TextBlockBuilder作为最外层的拼接器,如果有最外层的标签,则可以直接使用这个标签的包裹器作为文本拼接器。 + `DelegateBlock`的作用是通过委托来实时获取一个变量,示例中直接获取value的文本值,拼接到结果中。 -TextBlockBuilder 可以不依靠如`DelegateBlock这样的包裹器,可以直接将返回字符串类型的方法委传入,blocker 会自动识别; 前提是开启对应 blocker 里的compatibility兼容性检查,但这带来额外的性能开销,如果没有特别的需求,建议还是使用DelegateBlock`进行多态封装,这样也会更全。 +TextBlockBuilder 可以不依靠如`DelegateBlock`这样的包裹器,可以直接将返回字符串类型的方法委传入,blocker 会自动识别; 前提是开启对应 blocker 里的`compatibility`兼容性检查,但这带来额外的性能开销,如果没有特别的需求,建议还是使用`DelegateBlock`进行多态封装,这样也会更全。 在新的更新中,包裹器支持域写法,同时可以省略部分参数: ``` -// 下面这个包裹器也等同于: 重量[value]kg - +// 这个包裹器也等同于: 重量1.23kg _blockBuilder = new TextBlockBuilder() { new ColorBlock() // 默认值就是白色 { "重量" }, - new DelegateBlock(() => value.ToString()), + new NumberValueBlock(1.23), new SizeBlock(20) // 默认单位为像素 { "kg" @@ -501,14 +502,14 @@ _blockBuilder = new TextBlockBuilder() }; ``` -这里的作用与上面的示例完全一致,更新的包裹器中支持自动填入更多的默认值了,比如颜色默认为白色。 -虽然看起来更长了,但是对于较复杂的格式来说可以有更强的可读性,建议这样写。 -同时,委托包裹器并不是唯一设置动态参数的方式: +这里使用作用域的写法看起来更长了,但是对于较复杂的格式来说可以有更强的可读性,所以建议这样写。 +同时,还有更多的值包裹器: -* `SetParamters`:在根包裹器上使用赋值方法,可以将一系列值一一对应地填入到后续一系列包裹器中。 -* `RefernceBlock`:反射包裹器允许传入一个对象,以及成员名称来访问属性(字段,访问器,方法均可)。 -* `ValueBlock:值包裹器,搭配SetParamters`来设置值,目标需要实现Tostring方法。 -* `NumberValueBlock数值类型包裹器,搭配SetParamters`来设置值,设置值会自动限制在最最小范围内,如果给定的参数是字符串类型,将尝试通过默认的格式化方法转为数值。 +* `SetParamters`: 在根包裹器上使用赋值方法,可以将一系列值一一对应地填入到后续一系列包裹器中。 +* `DelegateBlock`: 委托包裹器允许声名一个返回值为字符串的委托来获取值。 +* `RefernceBlock`: 反射包裹器允许传入一个对象,以及成员名称来访问属性(字段,访问器,方法均可)。 +* `ValueBlock`: 值包裹器,搭配`SetParamters`来设置值,目标需要实现Tostring方法。 +* `NumberValueBlock`: 数值类型包裹器,搭配`SetParamters`来设置值,设置值会自动限制在最最小范围内,如果给定的参数是字符串类型,将尝试通过默认的格式化方法转为数值。 在实际使用时,只有`ValueBlock`默认会从`SetParamters`参数列表中获取值, 其他包裹器需要手动通过`SetParameterization`参数化包裹器,否则不会响应参数列表。 @@ -519,7 +520,7 @@ _blockBuilder = new TextBlockBuilder() 最后: * 关于体积:可以看到相比直接写富文本格式,这样写的体积更大。但对于开始不了解富文本格式的情况下,这个功能可以当作一种拼写检查。 * 关于安全:包裹器允许链式语法赋值,隐式地反向赋值,但部分模块也会使用反射功能,这可能会在部分平台上被认为是不安全的,并且可能不利于协作。 -* 关于性能:这种做法在创建时绝对不是省油的灯,绝对不要在运行时反复创建,而是声名在当前作用域的全局用作静态,或持实例唯一。 不过文本拼接不太需要担心,里面所有地方要拼接文本的地方都用了stringbuilder,比直接使用字符串内插可能还要高效。 +* 关于性能:这种做法可能比较浪费内存,使用时注意要声名在当前作用域的全局用作静态,或持实例唯一。 不过文本拼接不太需要担心,里面所有地方要拼接文本的地方都用了stringbuilder,比直接使用字符串内插可能还要高效。 ### 文本转换: @@ -557,7 +558,7 @@ _blockBuilder = new TextBlockBuilder() 提供寻路算法核,寻路几何体构造器 (未实装) 。 * AStart寻路算法核 -通过`AStart2提供,算法核只包含计算过程,需要被计算的对象上实现接口IAstartNavNeighborNode`。 +通过`AStart2`提供,算法核只包含计算过程,需要被计算的对象上实现接口`IAstartNavNeighborNode`。 接口中需要定义当前“可寻路对象”的距离模式,相邻代价,以及所有邻居。 如果需要定义管理器,可使用`AStartNode`进行快速封装。