feat(积木模式): update article.md; update code and umls;

yyc-git · yyc-git · commit 87d90fe417f4 · 2023-04-09T07:39:25.000+08:00
diff --git a/doc/TODO.org b/doc/TODO.org
@@ -293,6 +293,17 @@ finish TODO
 
 * TODO finish block pattern article
 
+** DONE update article 1
+
+** TODO update article 2
+
+remove comment
+
+add image
+
+finish TODO
+
+
 
 
 
@@ -309,7 +320,7 @@ TODO handle 依赖隔离模式
 * TODO 简化UML
 
 
-* TODO improve story
+* TODO unify story
 
 一家公司，开发项目
 
@@ -320,7 +331,7 @@ TODO handle 依赖隔离模式
 经理
     老刘
 
-* TODO improve 给出UML 的描述
+* TODO unify 给出UML 的描述
 
 先说“总体上来看，xxx”
 然后再介绍每个部分的具体模块
@@ -330,6 +341,7 @@ TODO handle 依赖隔离模式
 使用总-分-总?套路，最后一个总可选
 
 
+* TODO 在给出代码->结束一段代码的分析时，给出承上启下语句：总结上段代码，引出下段代码
 
 
 * TODO give where has code, uml and how to run code and run result for each example
diff --git a/packages/积木模式/article.md b/packages/积木模式/article.md
diff --git a/packages/积木模式/store_after/UML.drawio b/packages/积木模式/store_after/UML.drawio
@@ -1 +1 @@
-<mxfile host="Electron" modified="2023-03-10T03:52:59.822Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="U3K1AEpFS70dRIiy7Dvf" version="14.6.13" type="device"><diagram id="n54MDWuAZzM2yzlB0eEC" name="第 1 页">1VhNc5swEP01PibDp22OrU2dTupLPJ3GvWlgA+oA65GFDf31FWGxILQed9pg7IvZtyskvX1aFib2Ii1Wgu3iNYaQTCwjLCb2cmJZ5tyx1V+FlIQ4llEjkeAhYRrY8J9AYBOW8xD2nUCJmEi+64IBZhkEsoMxIfDYDXvBpDvrjkXQAzYBS/roNx7KuEbn1kzjD8CjuJnZnHq1J2VNMO1kH7MQjy3I9if2QiDK+iotFpBU7DW81OM+/cF7WpiATF4yYH+4843PX1fOA8r08cPT6vujc0d3ObAkpw3TYmXZMAChIoRMFDLGCDOW+Br9KDDPQqimMZSlY74g7hRoKvAHSFlSdlkuUUGxTBPy9rdC69pjLgI4s35armQiAnkmzqnjqr20JiCiVoApSFGqAAEJk/zQTT4jDUWnOE2zuiCm/4J1q8f6IuHV3t9y3+LoBTNJBNrWOc4OICQUZ3fZeKckTTqctmHcG60fLfOodW/OaETc0nxzl/9Ok33j4nQuFKc7KnGaV2FZkSvKZxr/amwr495tzGXRdi5Lst4/O/NRZcfpnQk/i3gGA5cOxxx36WiWN7CICy6ftWyVtW15tIIr498F7F4oYG9UAjbNa2Tm/VkeV5lwe2ViyYXqj1EMXChmxrgLxbRH1Lpq3IclafqmEVP2qEgynds6s/MLz+x0VGd23pPiJoAM1ixTL5lDn1vX7UrS8YyeCNVhHlKE9m2J0LvJB4fpXqVxOnX/uuHfdvr933f/wzZcl2Z0XGXF65WVJ1DZGrqgnD6Z6YIy0DNOmfor26uv9bHS9n8B</diagram></mxfile>
+<mxfile host="Electron" modified="2023-04-08T21:56:35.130Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="UXuD1wpNQ8v8wYkrHiC-" version="14.6.13" type="device"><diagram id="n54MDWuAZzM2yzlB0eEC" name="第 1 页">3VhNj9owEP01Oe4qzhdwbIGy1ZbLoqrL3qxkNnGV2MgYCP31dTZjnGy0iEptSOFC5nkce+a9mcRx/GlRLiTdZEuRQO54blI6/szxPELcSP9VyLFGxqFXA6lkCTpZYMV+AYIuojuWwLblqITIFdu0wVhwDrFqYVRKcWi7vYq8veqGptABVjHNu+gPlqgMo/BGFn8AlmZmZRJN6pGCGmeMZJvRRBwakD93/KkUQtVXRTmFvEqeyUs978sHo6eNSeDqkgnb/d3c/fp9ETwIVTx+elq8PAZ3eJc9zXcYMG5WHU0GINEJQVNIlYlUcJrPLfpZih1PoFrG1Zb1+SbERoNEgz9BqSOyS3dKaChTRY6jwA3zJNLmVlGpmkA3VNz3VuxkDGfiw3D0DVNQZ/yC2q+KtbEAJnIBogAlj9pBQk4V27fFQVFj6cnP0qAvkIk/YMXrsDLNWRX7e24aOXwV3OTM987lbA9SQXk2SjMaoXSxdn3XvXcbP9zmwdYFGeGMrFET5i5/PU3+jYs3uFC84aDES67Egt77M85/M9aVcR8ac1Y2B2fHk3Vt9saDYi/o1NScp4xDz60nIMNuPWZ7PYu8ZOrZylpb68aIVXhl/HuBhxcKfDIogRNyFeauzsKw2kzYaTMzJvX7u5A9N5qRO+xGE3UStawOFv0mKXr3IqjtQSWJBLdV0+MLazoaVE2PO1JdxcBhSbk+JPdd12HYlmwwcTsi1cXep0j92xLp5L988JDwOiyY04k9kKyd5nnkg9PJoF74LmV8WG1p0mlLTzpFvTek0ydD25B6eoZq035lfBtrfKv1578B</diagram></mxfile>
diff --git a/packages/积木模式/story_before/UML.drawio b/packages/积木模式/story_before/UML.drawio
@@ -1 +1 @@
-<mxfile host="Electron" modified="2023-03-06T04:52:05.000Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="hyoA1z2xjHiYhuDLVRl7" version="14.6.13" type="device"><diagram id="NGeyM_KxfF-s6x-JSchb" name="第 1 页">3ZZNT4NAEIZ/DUcNH/3Qq7TaxPbURL2ZTXcKqwvTbIeW+utdZCggaVMT0xq5wL47w8w8vAScIEzyByNW8QwlaMd3Ze4EI8f3Pc8d2FOh7Erlpu+XQmSU5KBamKsPYNFlNVMS1q1AQtSkVm1xgWkKC2ppwhjctsOWqNtVVyKCjjBfCN1Vn5WkmKfwh7U+ARXFVWVvcFvuJKIK5knWsZC4bUjB2AlCg0jlVZKHoAt4FZcy7/7A7r4xAymdkhBOho/5/WwayVecv7y7GD71r/guG6EzHpibpV1FAKQFwks0FGOEqdDjWr0zmKUSijKuXdUxU8SVFT0rvgHRjp+uyAitFFOiebesWRQ6OBtLa8zMAo4MxP2TMBHQkbje/glY6wImQGZn8wxoQWrT7kOwh6J9XI3ZXjDpH1D3O9RDrYpRv7NvMFpiSgww8PfMNmAI8uPUulNWCQO2Jr+bgeteu42D29zWvveGnBE3PF/d5dcxBf/NnL0Tzdm/pDl7HerjNFIpnNmcPe9vm7PfwTRSxn6B0JwZ1OBib7Fd1p+vr73GT0Aw/gQ=</diagram></mxfile>
+<mxfile host="Electron" modified="2023-04-08T21:56:50.722Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="0oG-g6wyKeGiANLPNREi" version="14.6.13" type="device"><diagram id="NGeyM_KxfF-s6x-JSchb" name="第 1 页">3VZNT4NAEP01HDV8tFSv0qqJemqi3symO4XVZafZDi3117vIICCRaGLUyAX2zduP92YmixcleXlhxSa7QQnaC31ZetHcC8Mg8GP3qpBDjZxMwxpIrZJMaoGlegYGfUYLJWHbIxKiJrXpgys0BlbUw4S1uO/T1qj7u25ECgNguRJ6iN4pSRmrCGctfgkqzZqdg/i0juSiIbOSbSYk7jtQtPCixCJS/ZWXCejKvMaXet75B9G3g1kw9JkJyeXsqjy/uU7lAy7vn3xMbqdHvMpO6IIF82Hp0DgA0hnCQ7SUYYpG6EWLnlksjIRqG9+NWs414saBgQMfgejA2RUFoYMyyjVHwTSZD2I33JKw1AWGUvncWyzsCkb0sRy3YAo0wpvUvEprZwM28gIwB7IHR7CgBaldvzgE11j6xmvT4D44E1/ISjjISqJVpf19bjoertE0nkXhmGc7sATlqMomGnPpcu9Gvn/sdx4+5r7ti2DGM7JOTzSrfLtN0T8v3skni3f6p4p3MsjKwqTKwA8X7yT428U7Hdg0V9bdYGh/2Kj417rcDdvr7zXW+YmIFi8=</diagram></mxfile>
diff --git a/积木模式代码_ts/director_block/src/Main.ts b/积木模式代码_ts/director_block/src/Main.ts
@@ -10,12 +10,12 @@ let requestAnimationFrame = (func) => {
 }
 
 let _loop = (api: api, blockManagerState: blockManagerState, sceneManagerBlockProtocolName: blockProtocolName, renderBlockProtocolName: blockProtocolName) => {
-	//通过SceneManager Block Protocol接口来调用SceneManager Block的服务的update函数
+	//通过SceneManager Block Protocol来调用SceneManager Block的服务的update函数
 	let sceneManagerService = api.getBlockService<sceneManagerService>(blockManagerState, sceneManagerBlockProtocolName)
 
 	blockManagerState = sceneManagerService.update(blockManagerState)
 
-	//通过Render Block Protocol接口来调用Render Block的服务的render函数
+	//通过Render Block Protocol来调用Render Block的服务的render函数
 	let renderService = api.getBlockService<renderService>(blockManagerState, renderBlockProtocolName)
 
 	blockManagerState = renderService.render(blockManagerState)
@@ -33,12 +33,12 @@ export let getBlockService: getBlockServiceBlockManager<
 > = (api, { sceneManagerBlockProtocolName, renderBlockProtocolName }) => {
 	return {
 		init: (blockManagerState) => {
-			//通过SceneManager Block Protocol接口来调用SceneManager Block的服务的init函数
+			//通过SceneManager Block Protocol来调用SceneManager Block的服务的init函数
 			let sceneManagerService = api.getBlockService<sceneManagerService>(blockManagerState, sceneManagerBlockProtocolName)
 
 			blockManagerState = sceneManagerService.init(blockManagerState)
 
-			//通过Render Block Protocol接口来调用Render Block的服务的init函数
+			//通过Render Block Protocol来调用Render Block的服务的init函数
 			let renderService = api.getBlockService<renderService>(blockManagerState, renderBlockProtocolName)
 
 			blockManagerState = renderService.init(blockManagerState)
diff --git a/积木模式代码_ts/engine_block/src/Main.ts b/积木模式代码_ts/engine_block/src/Main.ts
@@ -8,30 +8,30 @@ import { dependentBlockProtocolNameMap } from "./DependentMapType"
 
 //实现积木协议定义的服务
 export let getBlockService: getBlockServiceBlockManager<
-	//Engine Block->dependentBlockProtocolNameMap
+    //该类型定义在Engine Block->DependentBlockProtocolNameMap
 	dependentBlockProtocolNameMap,
-	//Engine Block Protocol->ServiceType->service
+    //该类型是Engine Block Protocol->ServiceType->service
 	engineService
 > = (api, { directorBlockProtocolName, sceneManagerBlockProtocolName }) => {
     //返回服务
 	return {
 		director: {
 			init: (blockManagerState) => {
-				//通过Director Block Protocol接口来调用Director Block的服务的init函数
+				//通过Director Block Protocol来调用Director Block的服务的init函数
 				let { init } = api.getBlockService<directorService>(blockManagerState, directorBlockProtocolName)
 
 				return init(blockManagerState)
 			},
 			loop: (blockManagerState) => {
-				//通过Director Block Protocol接口来调用Director Block的服务的loop函数
+				//通过Director Block Protocol来调用Director Block的服务的loop函数
 				let { loop } = api.getBlockService<directorService>(blockManagerState, directorBlockProtocolName)
 
 				return loop(blockManagerState)
 			}
 		},
 		scene: {
 			createScene: (blockManagerState) => {
-				//通过SceneManager Block Protocol接口来调用SceneManager Block的服务的createScene函数
+				//通过SceneManager Block Protocol来调用SceneManager Block的服务的createScene函数
 				let { createScene } = api.getBlockService<sceneManagerService>(blockManagerState, sceneManagerBlockProtocolName)
 
 				//因为createScene函数返回了新的SceneManager Block的state，所以调用BlockManager的api的setBlockState将其保存到BlockManagerState中，并返回新的BlockManagerState
@@ -47,13 +47,14 @@ export let getBlockService: getBlockServiceBlockManager<
 
 //实现积木协议定义的state
 export let createBlockState: createBlockStateBlockManager<
+    //该类型是Engine Block Protocol->StateType->state
 	engineState
 > = () => {
-    //返回state
+    //返回state，该state为空
 	return null
 }
 
-//获得依赖的所有的积木协议名
+//获得依赖的所有积木协议名
 export let getDependentBlockProtocolNameMap: getDependentBlockProtocolNameMapBlockManager = () => {
 	return {
 		"directorBlockProtocolName": "director_block_protocol",
diff --git a/积木模式代码_ts/render_block/src/Main.ts b/积木模式代码_ts/render_block/src/Main.ts
@@ -17,14 +17,14 @@ export let getBlockService: getBlockServiceBlockManager<
 			return blockManagerState
 		},
 		render: (blockManagerState) => {
-			//通过SceneManager Block Protocol接口来调用SceneManager Block的服务的getAllGameObjects函数
+			//通过SceneManager Block Protocol来调用SceneManager Block的服务的getAllGameObjects函数
 			let { getAllGameObjects } = api.getBlockService<sceneManagerService>(blockManagerState, sceneManagerBlockProtocolName)
 
 			let allGameObjects = getAllGameObjects(api.getBlockState<sceneManagerState>(blockManagerState, sceneManagerBlockProtocolName))
 
 			console.log("处理场景数据")
 
-			//通过Math Block Protocol接口来调用Math Block的服务的multiplyMatrix函数
+			//通过Math Block Protocol来调用Math Block的服务的multiplyMatrix函数
 			let { multiplyMatrix } = api.getBlockService<mathService>(blockManagerState, mathBlockProtocolName)
 
 			let _ = multiplyMatrix(1, 2)
diff --git a/积木模式代码_ts/sceneManager_block/src/Main.ts b/积木模式代码_ts/sceneManager_block/src/Main.ts
@@ -30,7 +30,7 @@ export let getBlockService: getBlockServiceBlockManager<
 		update: (blockManagerState) => {
 			console.log("更新场景")
 
-			//通过Math Block Protocol接口来调用Math Block的服务的multiplyMatrix函数
+			//通过Math Block Protocol来调用Math Block的服务的multiplyMatrix函数
 			let { multiplyMatrix } = api.getBlockService<mathService>(blockManagerState, mathBlockProtocolName)
 
 			let _ = multiplyMatrix(1, 2)
diff --git a/积木模式代码_ts/story_improve/src/Client.ts b/积木模式代码_ts/story_improve/src/Client.ts
@@ -3,7 +3,7 @@ import { service } from "engine_block_protocol/src/service/ServiceType";
 
 let blockManagerState = init()
 
-//传入的service为Engine Block Protocol定义的服务
+//获得了入口积木-Engine Block的服务
 let { director, scene } = getBlockService<service>(blockManagerState, getEntryBlockProtocolName())
 
 blockManagerState = scene.createScene(blockManagerState)
diff --git a/积木模式抽象代码/block_facade_abstract/src/Main.ts b/积木模式抽象代码/block_facade_abstract/src/Main.ts
@@ -16,7 +16,7 @@ export let init = (): blockManagerState => {
 
     blockManagerState = registerBlock(
         blockManagerState,
-        "entry_block_abstract_protocol",
+        "entry_block_protocol",
         getEntryBlockService,
         getDependentEntryBlockProtocolNameMap(),
         createEntryBlockState()
@@ -35,7 +35,7 @@ export let init = (): blockManagerState => {
 }
 
 
-export let getEntryBlockProtocolName = () => "entry_block_abstract_protocol"
+export let getEntryBlockProtocolName = () => "entry_block_protocol"
 
 export let getBlockService = <blockService>(blockManagerState: blockManagerState, blockProtocolName: blockProtocolName) => {
     return getBlockServiceExn<blockService>(blockManagerState, blockProtocolName)
diff --git a/积木模式抽象代码/entry_block_protocol_abstract/src/service/ServiceType.ts b/积木模式抽象代码/entry_block_protocol_abstract/src/service/ServiceType.ts
@@ -1,3 +1,3 @@
 export type service = {
-	定义API的类型...
+	...
 }
diff --git a/积木模式抽象代码/entry_block_protocol_abstract/src/state/StateType.ts b/积木模式抽象代码/entry_block_protocol_abstract/src/state/StateType.ts
@@ -1,2 +1,5 @@
-export type state = ...（通常为null）
+//如果为空则为null
+export type state = {
+    ...
+}
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-<mxfile host="Electron" modified="2023-03-10T03:52:59.822Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="U3K1AEpFS70dRIiy7Dvf" version="14.6.13" type="device"><diagram id="n54MDWuAZzM2yzlB0eEC" name="第 1 页">1VhNc5swEP01PibDp22OrU2dTupLPJ3GvWlgA+oA65GFDf31FWGxILQed9pg7IvZtyskvX1aFib2Ii1Wgu3iNYaQTCwjLCb2cmJZ5tyx1V+FlIQ4llEjkeAhYRrY8J9AYBOW8xD2nUCJmEi+64IBZhkEsoMxIfDYDXvBpDvrjkXQAzYBS/roNx7KuEbn1kzjD8CjuJnZnHq1J2VNMO1kH7MQjy3I9if2QiDK+iotFpBU7DW81OM+/cF7WpiATF4yYH+4843PX1fOA8r08cPT6vujc0d3ObAkpw3TYmXZMAChIoRMFDLGCDOW+Br9KDDPQqimMZSlY74g7hRoKvAHSFlSdlkuUUGxTBPy9rdC69pjLgI4s35armQiAnkmzqnjqr20JiCiVoApSFGqAAEJk/zQTT4jDUWnOE2zuiCm/4J1q8f6IuHV3t9y3+LoBTNJBNrWOc4OICQUZ3fZeKckTTqctmHcG60fLfOodW/OaETc0nxzl/9Ok33j4nQuFKc7KnGaV2FZkSvKZxr/amwr495tzGXRdi5Lst4/O/NRZcfpnQk/i3gGA5cOxxx36WiWN7CICy6ftWyVtW15tIIr498F7F4oYG9UAjbNa2Tm/VkeV5lwe2ViyYXqj1EMXChmxrgLxbRH1Lpq3IclafqmEVP2qEgynds6s/MLz+x0VGd23pPiJoAM1ixTL5lDn1vX7UrS8YyeCNVhHlKE9m2J0LvJB4fpXqVxOnX/uuHfdvr933f/wzZcl2Z0XGXF65WVJ1DZGrqgnD6Z6YIy0DNOmfor26uv9bHS9n8B</diagram></mxfile>
	`1`	+<mxfile host="Electron" modified="2023-04-08T21:56:35.130Z" agent="5.0 (Macintosh; Intel Mac OS X 11_4_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="UXuD1wpNQ8v8wYkrHiC-" version="14.6.13" type="device"><diagram id="n54MDWuAZzM2yzlB0eEC" name="第 1 页">3VhNj9owEP01Oe4qzhdwbIGy1ZbLoqrL3qxkNnGV2MgYCP31dTZjnGy0iEptSOFC5nkce+a9mcRx/GlRLiTdZEuRQO54blI6/szxPELcSP9VyLFGxqFXA6lkCTpZYMV+AYIuojuWwLblqITIFdu0wVhwDrFqYVRKcWi7vYq8veqGptABVjHNu+gPlqgMo/BGFn8AlmZmZRJN6pGCGmeMZJvRRBwakD93/KkUQtVXRTmFvEqeyUs978sHo6eNSeDqkgnb/d3c/fp9ETwIVTx+elq8PAZ3eJc9zXcYMG5WHU0GINEJQVNIlYlUcJrPLfpZih1PoFrG1Zb1+SbERoNEgz9BqSOyS3dKaChTRY6jwA3zJNLmVlGpmkA3VNz3VuxkDGfiw3D0DVNQZ/yC2q+KtbEAJnIBogAlj9pBQk4V27fFQVFj6cnP0qAvkIk/YMXrsDLNWRX7e24aOXwV3OTM987lbA9SQXk2SjMaoXSxdn3XvXcbP9zmwdYFGeGMrFET5i5/PU3+jYs3uFC84aDES67Egt77M85/M9aVcR8ac1Y2B2fHk3Vt9saDYi/o1NScp4xDz60nIMNuPWZ7PYu8ZOrZylpb68aIVXhl/HuBhxcKfDIogRNyFeauzsKw2kzYaTMzJvX7u5A9N5qRO+xGE3UStawOFv0mKXr3IqjtQSWJBLdV0+MLazoaVE2PO1JdxcBhSbk+JPdd12HYlmwwcTsi1cXep0j92xLp5L988JDwOiyY04k9kKyd5nnkg9PJoF74LmV8WG1p0mlLTzpFvTek0ydD25B6eoZq035lfBtrfKv1578B</diagram></mxfile>