问题标签 [asdoc]

我想让ASDoc Ant 任务工作：

当我运行它时，我从 ASDoc 收到错误，例如“错误：找不到类型或不是编译时常量：XXX”。当我手动运行 ASDoc 时，我会这样做：“asdoc -source-path src -doc-sources src”。如果我省略 -source-path 值，我会得到相同的错误......那么我应该如何让 Ant 任务工作？

有什么方法可以通过 Flex Builder UI 在您的项目上运行 ASDoc？或者，是否有一个好的（最好是免费的）插件可以做到这一点？

如果没有它的 UI，是否有人有一个教程的链接，关于如何在我构建我的项目时将其设置为自动，可能是通过 Ant（我从未使用过，但我很乐意尝试）或者其他的东西？（对不起，多部分问题）

我的意思是内置的 ECMA 对象：String、Number、Object、Function、RegExp、Error、Boolean 等。

我有一个要分发的 Flash (AS3) 组件库，我想确保每个版本都有完整的文档记录。我真正喜欢 Microsoft 为 C# 自动生成文档的一件事是，我可以让我的编译器为任何未以文档标记格式记录的公共成员生成警告（在每次编译时）。

我发现这对我确保我已经完全记录了我的所有代码非常有帮助。

有没有办法为 ASDoc 打开类似的东西？

感谢您提供的任何建议和技巧——我希望在 Eclipse / Flex Builder 中使用它，但我可以使用 Ant。

我们一直在尝试针对 Flex 3 库项目编译 ASDocs。我们的问题是 ASDocs 拒绝识别在库中创建和使用的任何自定义 mxml 组件。

例如，如果我们的库中有一个自定义的 mxml AdvancedButton 控件，并且我们尝试在库中的另一个 mxml 类中使用它，ASDocs 编译器会在父类文件上出错，并显示“错误：找不到类型或未找到类型”一个编译时常量：AdvancedButton”。

如果我们尝试扩展我们的自定义组件，也会发生错误。因此，如果我们的库包含扩展 Button 的 AdvancedButton 和扩展 AdvancedButton 的 ExtraAdvancedButton，则 ASDocs 将“无法找到指定的基类 'AdvancedButton for component class 'ExtraAdvancedButton'”。

另一方面，如果 AdvancedButton 是从外部库中引用的，我们不会得到错误。

如果文件是 .as 而不是 .mxml，这似乎不是问题。然而，在我们的例子中，我们嵌套了基于 degrafa 的组件。

想法将不胜感激。

这个问题涉及使用 ASDoc 从 AS3 创建文档。我不是通过 Flex 或其他任何方式执行此操作，而是使用命令行，尽管一切正常且 ASDoc 没有返回任何错误，但生成的文档中的某些链接已损坏。

具体来说，在文档的其他部分（包括在同一类中）中存在指向属性或方法的链接的所有地方，该链接最终会使与包对应的文件夹翻倍。

例如，假设我正在记录myPackage.MyClass. 如果MyClass有一个名为 的属性MyProperty，并且在我的文档中的某处，我包含了这样的一行：

然后正确解析文档并正确创建“另请参阅：”链接，但最终指向

当然，在实际文件系统中只有一个myPackage文件夹。

我的 ASDoc 命令的相关部分如下所示：

我是否可能遗漏了一些 ASDoc 参数来指定链接的基本 URL，或者类似的东西？如果这是一个简单的错误，对许多人来说很明显，但我找不到任何关于该问题的谷歌结果，所以我的工作假设是它不会发生在从 Flex 运行 ASDoc 的人身上，也许是因为我的某些设置'已省略。

谢谢你的帮助！

在 TypeOneError 的建议下，我尝试了不同类型的 @see 链接。我发现这些工作正常：

• @see some.package
• @see ClassName
• @see ClassName#property

虽然这些不起作用：

• @see #property
• @see full.package.ClassName
• @see full.package.ClassName#property

更糟糕的是，尽管所有导航链接都有效，但自动生成的类型链接中会出现相同的双重路径。例如，当它显示每个方法的签名时，当方法返回文档中的类时，该链接就会断开。

我还查看了 HTML，发现问题似乎与页面的基本 URL 或任何内容无关，只是链接不一致。因此，在一排连续的@see链接中，其中一些链接到ClassName.html，一些链接到package/ClassName.html，按照上面显示的规则。顺便说一句，无论页面是否在框架中查看，所有这些都是正确的。

如果我想出任何东西，请提供更多信息，但最欢迎解决方法的想法。

更新：更多细节：我不确定我的确切 SDK 版本，除了它附带 Flex 3，但如果我不带参数运行 ASDoc，它会报告：Adobe ASDoc Version 3.3.0 build 4852. 我在 Windows XP 上从放置在类路径目录中的批处理文件中运行这一切。

部分解决方案：通过升级到 Flex 4 SDK 的 4.0.0.7219 beta 版本（并使用其中分发的 ASDoc）解决了我的所有问题，但其中一个问题除外。现在，我的所有@see标签都按预期工作。剩下的唯一问题是，无论我有一个方法返回一个属于我的文档的一部分的类，ASDoc 都会简单地破坏链接。例如，如果我有一个签名为 的方法ClassA#getB():ClassB，那么在文档中显示的地方，文本“ClassB”链接到“packageName:ClassB.html”而不是“packageName/ClassB.html”。这似乎是一个简单的错误。呜呜。

运行 asdoc 时无法在 actionscript 文件中显示注释。这是一个已知的错误吗？

在生成的文档中没有显示任何内容......我做错了吗？

我正在使用 ASDoc 创建我的 flex 项目的文档，并且遇到了可绑定元标记的一些问题。

• ASDoc 不会记录 public Bindable 值，除非 Bindable 标记具有与之关联的事件名称。

例如：

• 如果可绑定标签没有与之关联的事件名称，ASDoc 会在值名称前添加随机字符串。protected Bindable

例如：

总而言之，ASDoc 对Bindable没有事件名称的标签不满意。似乎最简单的解决方案是，只要您将某些东西声明为可绑定的，就指定一个事件名称。但是flex 文档说，如果您使用 Bindable 标签指定事件名称，那么“您负责生成和调度事件”。我的项目几乎完成了，而且我在很多地方都依赖于绑定（没有事件名称），这使得回去改变一切变得不切实际——这需要很多努力；加上弄乱用于创建文档的工作代码的想法对我来说听起来很可怕。

在生成 asdoc 之前替换所有[Bindable]实例，[Bindable("blah")]然后将它们改回来是我能想到的唯一解决方法。但我觉得应该有更好的方法。

Adobe错误跟踪器声称公共变量的问题已在最新版本中得到修复，因此我下载了最新的 flex sdk (3.4) 并尝试使用它附带的 ASDoc - 但它给了我相同的结果。

任何人都可以对这个问题有所了解吗？

此外，Adobe 博客说ASDoc 现在也支持 mxml，但是当我尝试使用最新的 (flex 3.4) ASDoc 时，我的 mxml asdoc 注释（嵌入在 中）没有出现在生成的 html 页面中。有谁知道最新的 asdoc 是否可以单独下载？

有谁知道您是否可以编写 asdoc 将识别和使用的自己的页面？例如，我想写一些“Getting Started”、“Support”和“FAQ”之类的页面来帮助理解我的 actionscript 类是关于什么的。

可以将 ASDoc 设置为记录私有成员 ala JavaDoc 吗？