增加文档

Game/CharacterScript/Common/Move.nut

@@ -5,6 +5,12 @@
 文件用途:角色移动脚本
 */
 
+/**
+ *
+ * @function
+ * @param {ActiveObject} obj
+ * @returns {void}
+ */
 function checkCanChangeState_Character_Move(obj) {
 	//获取当前状态
 	local CurState = obj.GetState();
@@ -15,6 +21,12 @@ function checkCanChangeState_Character_Move(obj) {
 	} else return false;
 }
 
+/**
+ *
+ * @function
+ * @param {ActiveObject} obj
+ * @returns {void}
+ */
 function SetState_Character_Move(obj) {
 	//获取移动数据
 	local arr = obj.GetVars("_move_data_", "float");
@@ -33,16 +45,23 @@ function SetState_Character_Move(obj) {
 	local Dir = obj.GetDirection();
 	local Pos = obj.GetPosition();
 	local XOffset = null;
-    if (fabs(arr[0]) > 0.35) XOffset = ((arr[0] > 0 ? Speed : -Speed));
+	if (fabs(arr[0]) > 0.35) XOffset = arr[0] > 0 ? Speed : -Speed;
 	else XOffset = 0;
 	local YOffset = null;
 	//当摇杆Y轴大于0.35或小于-0.35时，设置Y轴偏移量
-    if (fabs(arr[1]) > 0.35) YOffset = (arr[1] > 0 ? Speed : -Speed);
+	if (fabs(arr[1]) > 0.35) YOffset = arr[1] > 0 ? Speed : -Speed;
 	else YOffset = 0;
 
 	obj.SetSpeed(XOffset, YOffset, null);
 }
 
+/**
+ *
+ * @function
+ * @param {ActiveObject} obj
+ * @param {integer} DeltaTime
+ * @returns {void}
+ */
 function ProcState_Character_Move(obj, DeltaTime) {
 	//获取移动数据
 	local arr = obj.GetVars("_move_data_", "float");

Game/ObjectClass/ActiveObject.nut

@@ -1,16 +1,21 @@
-/*
-文件名:ActiveObject.nut
-路径:Game/ObjectClass/ActiveObject.nut
-创建日期:2025-10-03	02:50
-文件用途:
-*/
-
+/**
+ * Description placeholder
+ * @global
+ * @param {*} Object
+ */
 class ActiveObject extends BaseObject {
-
 	constructor(Object) {
 		base.constructor(Object);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {integer} x
+	 * @param {integer} y
+	 * @param {integer} z
+	 * @returns {void}
+	 */
 	function SetSpeed(x, y, z) {
 		local CurSpeed = sq_GetSpeed(C_Object);
 		if (x == null) x = CurSpeed.x;
@@ -19,6 +24,11 @@ class ActiveObject extends BaseObject {
 		sq_SetSpeed(C_Object, x, y, z);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @returns {any}
+	 */
 	function GetSpeed() {
 		return sq_GetSpeed(C_Object);
 	}

Game/ObjectClass/BaseObject.nut

@@ -1,3 +1,7 @@
+/**
+ * Description placeholder
+ * @param {*} Object
+ */
 class BaseObject {
 	//c++对象指针
 	C_Object = null;
@@ -6,26 +10,65 @@ class BaseObject {
 		C_Object = Object;
 	}
 
+	/**
+	 *
+	 * @function
+	 * @returns {any}
+	 */
 	function GetPosition() {
 		return sq_GetPosition(C_Object);
 	}
-
+	//
+	/**
+	 *
+	 * @function
+	 * @param {integer} x
+	 * @param {integer} y
+	 * @param {integer} z
+	 * @returns {void}
+	 */
 	function SetPosition(x, y, z) {
 		sq_SetPosition(C_Object, x, y, z);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {string} Name
+	 * @param {any} Type
+	 * @returns {any}
+	 */
 	function GetVars(Name, Type) {
 		return sq_GetVars(C_Object, Name, Type);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {string} Name
+	 * @param {any} Type
+	 * @param {any} Value
+	 * @returns {void}
+	 */
 	function SetVars(Name, Type, Value) {
 		sq_SetVars(C_Object, Name, Type, Value);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @returns {integer}
+	 */
 	function GetDirection() {
 		return sq_GetDirection(C_Object);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {integer} Dir
+	 * @returns {void}
+	 */
 	function SetDirection(Dir) {
 		sq_SetDirection(C_Object, Dir);
 	}

Game/ObjectClass/CharacterObject.nut

@@ -1,22 +1,37 @@
-/*
-文件名:CharacterObject.nut
-路径:Game/ObjectClass/CharacterObject.nut
-创建日期:2025-10-03	02:50
-文件用途:
-*/
+/**
+ * Description placeholder
+ * @param {*} Object
+ */
 class CharacterObject extends ActiveObject {
 	constructor(Object) {
 		base.constructor(Object);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @returns {*}
+	 */
 	function GetState() {
 		return sq_GetState(C_Object);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {integer} State
+	 * @returns {void}
+	 */
 	function SetState(State) {
 		sq_SetState(C_Object, State);
 	}
 
+	/**
+	 *
+	 * @function
+	 * @param {any} key
+	 * @returns {void}
+	 */
 	function SetAction(key) {
 		sq_SetAction(C_Object, key);
 	}

Game/StateMachine/StateMachine.nut

@@ -5,6 +5,9 @@
 文件用途:
 */
 
+/** 状态机
+ * @global
+ */
 class StateMachine {
 	//状态注册表
 	StatusRegistry = null;
@@ -16,12 +19,16 @@ class StateMachine {
 		}
 		//初始化状态注册表
 		StatusRegistry = {};
-        foreach(JobIndex in getconsttable().CHARACTERJOB) {
+		foreach (JobIndex in getconsttable().CHARACTERJOB) {
 			StatusRegistry[JobIndex] <- {};
 		}
 	}
 
-    // 静态方法：获取唯一实例
+	/**
+	 * 静态方法：获取唯一实例
+	 * @function
+	 * @returns {table}
+	 */
 	function GetInstance() {
 		if (!getroottable().rawin("__StateMachine__")) {
 			// 首次调用时创建实例
@@ -30,16 +37,29 @@ class StateMachine {
 		return getroottable()["__StateMachine__"];
 	}
 
-    //注册状态
+	/**
+	 * 注册状态
+	 * @function
+	 * @param {integer} Job
+	 * @param {any} StateName
+	 * @param {integer} StateIndex
+	 * @returns {void}
+	 */
 	function RegisterState(Job, StateName, StateIndex) {
 		StatusRegistry[Job][StateIndex] <- {
 			StateName = StateName,
 			StateIndex = StateIndex
-        }
+		};
 		print("注册了状态" + StateName + "，状态索引为" + StateIndex);
 	}
 
-    //获取状态信息
+	/**
+	 * 获取状态信息
+	 * @function
+	 * @param {integer} Job
+	 * @param {integer} State
+	 * @returns {integer}
+	 */
 	function GetStateInfo(Job, State) {
 		return StatusRegistry[Job][State];
 	}

internalInterfaceDoc/func.nut

@@ -0,0 +1,95 @@
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {integer} state
+ * @returns {void}
+ */
+function sq_SetState(C_Object, state) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {any} key
+ *
+ * @returns {void}
+ */
+function sq_SetAction(C_Object, key) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @returns {void}
+ */
+function sq_GetSpeed(C_Object) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {integer} x
+ * @param {integer} y
+ * @param {integer} z
+ * @returns {void}
+ */
+function sq_SetSpeed(C_Object, x, y, z) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @returns {void}
+ */
+function sq_GetPosition(C_Object) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {integer} x
+ * @param {integer} y
+ * @param {integer} z
+ * @returns {void}
+ */
+function sq_SetPosition(C_Object, x, y, z) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {string} Name
+ * @param {any} Type
+ * @returns {void}
+ */
+function sq_GetVars(C_Object, Name, Type) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {string} Name
+ * @param {any} Type
+ * @param {any} Value
+ * @returns {void}
+ */
+function sq_SetVars(C_Object, Name, Type, Value) {}
+
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @returns {void}
+ */
+function sq_GetDirection(C_Object) {
+
+}
+/**
+ *
+ * @function
+ * @param {any} C_Object
+ * @param {integer} Dir
+ * @returns {void}
+ */
+function sq_SetDirection(C_Object, Dir) {}

internalInterfaceDoc/文档注释须知.nut

@@ -0,0 +1,83 @@
+//Type Squirrel的类型名称与squirrel一致
+
+//integer->整数
+//float->浮点数
+//array或者[]代表任意类型数组
+//table->{}
+//string->字符串
+//boolean->布尔值
+
+//文档注释中指定类型的数组应该这么做
+
+/**
+ * Description placeholder
+ * @param {array(integer)} args
+ */
+function arrayExample(args) {}
+
+//任意类型的数组应该这么做
+
+/**
+ *
+ * @function
+ * @param {array} args
+ * @returns {void} //如果不写@returns 代表返回null，{void}或{*}代表返回any
+ */
+function anyArrayExample(args) {}
+
+//以下是其他类型的文档注释示例
+/**
+ *
+ * @function
+ * @param {integer} args
+ * @returns {void}
+ */
+function intExample(args) {}
+
+/**
+ *
+ * @function
+ * @param {float} args
+ * @returns {void}
+ */
+function floatExample(args) {}
+
+/**
+ * Description placeholder
+ * @param {string} args
+ */
+function stringExample(args) {}
+
+/**
+ *
+ * @function
+ * @param {boolean} args
+ * @returns {void}
+ */
+function boolExample(args) {}
+
+/**
+ *
+ * @function
+ * @param {table} args
+ * @returns {void}
+ */
+function tableExample(args) {}
+
+//以下是内联提示与hover
+local a = 1;
+local b = "1";
+local c = 1.1;
+local d = false;
+local t = {};
+local arr = [];
+local intArr = [1];
+local floatArr = [1.1];
+local strArr = ["str"];
+local anyArr = [];
+
+//以下是二元表达式类型推断
+local x = 1 + 1;
+local x1 = 1 / 1;
+local x2 = 1 * 0.1;
+local x3 = (1 + 1).tofloat() + (1 / 2).tofloat();