【UE】笔记：用 @param 标记，为蓝图节点的输入输出引脚添加注释
摘要：蓝图函数可以通过Javadoc风格的@param标签为输入输出引脚添加注释说明。具体格式为@param [引脚名] [描述]，注释内容会在创建新节点或重启编辑器时更新显示。这种方法适用于为函数和引脚提供详细说明，提升代码可读性。
·
很多人认为蓝图是无法为输入输出写注释的，其实不然。我们以自带的函数为例：
实际上，和U++一样，和蓝图函数描述中使用@param Javadoc标签，为已实现的输入输出引脚添加描述。
我们以这个计算函数为例：
使用@param修改函数的描述，格式为：
@param [引脚名] [描述]
例如：
计算无限长的直线与无限延伸的平面的交点。
提供直线的起始点和方向向量，以及平面的参考点和法线向量，能够计算出两者的交点坐标
@param StartPos 用于定义直线的位置。
@param Direction 直线的方向。
@param PlanePoint 定义平面的位置。
@param PlaneNormal 描述平面的朝向。
@param HitPoint 交点的坐标。
@param Hit 是否成功找到交点。
现在新建一个节点，查看节点说明：
查看引脚说明：
需要注意的是：
- 描述只在 “刷新节点（例如创建新的节点）” 或 “重启编辑器” 时才会更新显示内容。
火山引擎开发者社区是火山引擎打造的AI技术生态平台，聚焦Agent与大模型开发，提供豆包系列模型（图像/视频/视觉）、智能分析与会话工具，并配套评测集、动手实验室及行业案例库。社区通过技术沙龙、挑战赛等活动促进开发者成长，新用户可领50万Tokens权益，助力构建智能应用。
更多推荐
2
0- 0
已为社区贡献1条内容
所有评论(0)