如何为我在flex中定义的项目编写注释?

时间:2010-11-21 00:52:42

标签: flex asdoc

我想为Flex文档中的某些元素添加注释,并使用ASDoc处理注释。我可以轻松地为脚本部分执行此操作,但我最终得到了大量的丑陋“这个属性可以用作数据绑定的源。”我在Flex中声明的每个元素的消息。

有没有办法将注释嵌入到flex元素中,以便ASDoc可以读取它?我尝试过使用标准

<!-- --> 

符号,但这似乎不起作用。

编辑:这个符号似乎被HTML评论吞没了,我猜你知道它的样子......

3 个答案:

答案 0 :(得分:4)

如果没有看到您的代码,就很难确切知道发生了什么。 ASdocs的任何内容都不应该生成可绑定的编译器错误。您是从Flex编译器还是ASDoc编译器获得该错误的?您是否尝试记录MXML文档或ActionScript文档?

您是否阅读过这些文档?

ActionScript上:

/**
* Your Comment Goes Here
*/
ActionScript Element

MXML上? MXML ASDoc注释必须使用三个破折号,而不是第一个注释标记的2个破折号。像这样:

<!--- Your comment goes here -->
MXML Element

答案 1 :(得分:1)

您是否尝试在评论中添加评论?

根据Flex文档here,“因为ASDoc注释的格式使用ActionScript语法,所以只能在MXML文件的块中插入ASDoc注释。”

答案 2 :(得分:0)

您可以使用这些//和/ * * /(在ActionScript块中) 要注释掉MXML节点,请使用<!-- and end with -->