学习 Adobe Flash 中的 ActionScript 2.0

类中的注释

在类和接口中使用注释记录，可以帮助开发人员了解类的内容。可以在所有类文件的开头使用一段注释，其中提供类名称、其版本号、日期和您的版权。例如，您可以为类创建类似于以下注释的文档：

/**
  Pelican class
  version 1.2
  10/10/2005
  copyright Adobe Systems Incorporated
*/

块注释用于描述文件、数据结构、方法和文件说明。它们通常放在文件的开头和方法的前面或内部。

在典型的类或接口文件中有两种注释：文档注释和实现注释。文档注释用于描述代码规范，而不描述实现。可以使用文档注释描述接口、类、方法和构造函数。实现注释用于注释掉代码或对代码特定节的实现提供注释。

应为每个类、接口或成员使用一个文档注释，并在其后紧跟着声明。如果您有其它不适合放在文档注释中的文档信息，请使用实现注释（采用块注释或单行注释的形式）。实现注释紧随声明之后。

这两种注释使用的分隔符略有区别。文档注释是以 /** 和 */ 分隔的，而实现注释则是以 /* 和 */ 分隔的。

提示

不要添加与正在阅读的类没有直接关联的注释。例如，不要包含描述相应包的注释。

在类文件中还可以使用单行注释、块注释和尾随注释。有关这些注释类型的详细信息，请参阅以下各部分：