代码注释


在与其他人合作、处理大型项目时,甚至只是为了你自己的参考和调试方便的原因,在代码和脚本中留下注释非常重要。在 GameMaker Studio 2 中,有各种机制可以帮助你留下关于代码部分的笔记和注释,甚至可以对你当前正在编辑的物体的事件列表中看到整个代码块进行注释,这时你可以给你自己或同事留下笔记,或者解释一段特别棘手的代码,甚至只是提醒一些事情的作用。

你可以做的第一件事是留下简短的评论,可以在文本之前使用行注释 //。比如:

//初始化变量
sr = 10;
hp = 100;

你也可以留下多行注释,以便略去用于调试的完整代码段,甚至可以解释脚本的参数。为此你可以使用块注释 / * ...... * /,就像这样:

/*
用法:
diff = angle_difference(angle1,angle2);

angle1 第一个方向,度为单位,实数
angle2 第二个方向,度为单位,实数

返回:给定的两个角度之间的差异,度为单位,从-180到180

GMLscripts.com
*/
{
return ((((argument0 - argument1) mod 360) + 540) mod 360) - 180;
}

最后,如果你正在编写自定义脚本并希望控制 IDE 如何处理它们(即:具有自动补全或显示脚本参数),那么你应该使用 JSDoc 表示法编写注释,详细可以看 这里