ASDocs省略私人会员

时间:2011-02-16 16:49:58

标签: flash actionscript-3 asdoc

冰雹堆!!

我正在为我的同事开发一个框架,我在记录它时遇到了麻烦 ASDocs省略私有成员(即使没有@private指令)。

有没有办法强迫它记录它?

1 个答案:

答案 0 :(得分:3)

这来自ASDocs文档:

  

默认情况下,ASDoc工具会为ActionScript类中的所有公共元素和受保护元素生成输出,即使您省略了ASDoc注释也是如此。要使ASDoc忽略元素,请在注释中的任何位置插入包含@private标记的ASDoc注释。 ASDoc注释可以包含其他文本以及@private标记,该标记也会从输出中排除。

它明确地说“对于所有公共和受保护的元素”,这对于API文档是有意义的:私有成员不能从类外部访问,因此保持隐藏。

也可以看到这个答案:Documenting private members with ASDoc