学习 Adobe Flash 中的 ActionScript 2.0
语法和语言基础知识 > 关于语言标点符号 > 关于注释

关于注释

注释是一种使用简单易懂的句子对代码进行注解的方法，编译器不会对注释进行求值计算。可以在代码中使用注释来描述代码的作用或描述返回到文档中的数据。注释可帮助您记住重要的编码决定，并且对其他任何阅读您的代码的人也有帮助。注释必须清楚地解释代码的意图，而不是仅仅翻译代码。如果代码中有些内容阅读起来含义不明显，则应对其添加注释。

极力建议使用注释将备注添加到脚本。注释会记录您在代码中所做的决策，解答"如何做"和"为何做"这两类问题。它们可以使 ActionScript 更容易理解。例如，可以在注释中说明一个变通办法。这样，您或其他开发人员就很容易找到代码中需要更新或修复的部分。如果在 Flash 或 Flash Player 的未来版本中纠正了问题或者对有问题的部分做了改进，则可通过删除该临时解决办法来改进 ActionScript。

请避免使用混乱的注释。用一行等号 (=) 或星号 (*) 创建注释块或在注释周围形成隔离标记，就属于混乱的注释。请改用空白来分隔注释与 ActionScript。如果使用"动作"面板或"脚本"窗口中的"自动套用格式"按钮来设置 ActionScript 格式，则会删除空白。请记住将空白添加回代码中，或使用单个注释行 (//) 来维持间距；设置代码格式后，删除这些行要比尝试确定空白原先在什么位置更容易。

部署项目前，请将任何多余注释从代码中删除，例如，"定义变量 x 和 y"或对其他开发人员来说一眼就能看懂的其它注释。如果发现 ActionScript 中有许多多余的注释，请考虑是否需要改写代码中的某些部分。如果需要包括许多关于代码如何工作的注释，则通常表示 ActionScript 不够完美且不够直观。

如果启用了语法着色，注释在默认情况下为灰色。注释可以具有任意长度，且不会影响导出文件的大小，并且它们不必遵循 ActionScript 语法或关键字的规则。

查看 LiveDocs 上的注释