我最近采用了大部分可重用的代码,并将它们编译成SWC,以实现组织和易用性。由于这样做,我的文档都没有出现在Flash Builder提供的代码提示中。我搜索了项目设置,但我无法找到这样一个功能的设置,我不知道为什么它不再起作用了。
我使用Flash Builder的Build Automatically
功能编译了SWC。我还没有尝试使用ANT进行编译,但可能会在下次构建时尝试。 asdocs能够相对轻松地编译我所有库的完整文档,如果我自己使用原始AS文件,代码提示工作,所以我不相信它与我编写文档的方式有任何关系。例如:
/**
* <p>Batch adds variables from a generic object using name-value pairs</p>
* @param variables A generic <code>Object</code> that contains name-value
* pairs that will be used as the arguments of the REST request
*/
public function addVariables( variables:Object ):void {}
知道为什么代码提示不再起作用了吗?
答案 0 :(得分:2)
Flash Builder使用嵌入在SWC中的ASDocs来提供代码提示 - 遗憾的是,FB在构建SWC时不包含文档。
但是,可以使用ANT“手动”完成:
<target name="insertASDocs">
<zip destfile="PATH_TO_YOUR_SWC" update="true">
<zipfileset dir="ASDOCS_FOLDER/tempdita" prefix="docs">
<include name="*.*"/>
<exclude name="ASDoc_Config.xml"/>
<exclude name="overviews.xml"/>
</zipfileset>
</zip>
</target>
PATH_TO_YOUR_SWC是相对路径和swc名称(例如:myFolder / mySwc.swc)。 ASDOCS_FOLDER是存储生成的文档的文件夹。
ANT脚本只是将ASDoc添加到SWC中 - 在此之后,应该出现代码提示。
更新
忘记提到你需要在生成文档时将keep-xml设置为true(如果将它们插入到swc中):
<asdoc keep-xml="true" ...