转自云の部族

@see标签

@see标记的作用是生成一个参考引用。在一些情况下某些类、属性或者方法在其他地方有进行说明或者引用，这时候我们可以通过此标记来引用此例子来进行说明。其书写格式如下：

@see 引用 [显示文本]

为了更好的理解其含义，我将在原来的print方法中引入getString方法，然后getString方法中则采用@see标记来进行参考引用。

 1/**
 2* 输出信息
 3* @param firstParam 需要输出信息的对象
 4* @param aaaaaaa 输出格式
 5* @return 该函数无返回值
 6* @example 下面例子是通过print函数输出信息。
 7*
 8* var …

转自云の部族

@example标记

@example是可以为某个类、方法或者属性加一个说明性的例子，从而让自己的代码更加容易理解。其书写格式为：

1@example 例子的说明性文字 <listing version=”3.0”> 例子的代码 </listing>

从格式中可知，例子的代码是写在 <listing> 标记之中的，下面通过一个例子来说明一下，还是以print函数为例：

本文转自：云の部族

ASDoc是adobe官方提供的ActionScript的API文档生成工具，现在已经集成在FlexBuilder3中。笔者这段时间才刚刚接触到这个工具，所以在网站也搜索了一些资料来对这个工具作进一步的了解。不过中文的资料对此工具的介绍和使用也不是太多，经过我几天的努力，对一些国外资料的研究和总结写了以下这篇文章，这篇文章主要是对ASDoc在注释中所使用的标签作了一些深入的研究，现在把我在探索的这个过程中的一些心得分享给大家。

首先在这里要先介绍一下API文档生成形式格式和结构，为了了解ASDoc的生成形式，在第一个例子中将不采用任何ASDoc标记来注释类。类定义如下：