为asdoc设定example
时间:2011-10-02 20:59来源: 作者: 点击:
次
最近在学习用asdoc生成文档，我们在使用官方API文档的时候，都能看到有些类的底部会有关于这个类是如何使用的例子，他是如何做到的呢，其实用的就是这个指令：@includeExample xxx/example.as，在它后面跟的是例子的路径，但是有一点，我们不能因为想要写个小例子，就把它放
|
最近在学习用asdoc生成文档，我们在使用官方API文档的时候，都能看到有些类的底部会有关于这个类是如何使用的例子，他是如何做到的呢，其实用的就是这个指令：@includeExample xxx/example.as，在它后面跟的是例子的路径，但是有一点，我们不能因为想要写个小例子，就把它放在跟类相同的路径下吧，这会非常糟糕的，我们更希望把例子集中在一个文件夹下统一管理，有什么好办法吗，答案是肯定的。我们需要在编译语句后面加上-examples-path [盘符]:\[路径]，它指的就是我们存放例子的路径，但是一定要记住，存放example的路径最好跟类文件的路径是一样的，这样管理起来更方便。比如我把框架放在d盘名为powerboy的目录下，框架里有个cn.pboy.control.Button的类，它的路径看起来像这样：d:\powerboy\cn\pboy\control\Button.as，现在我要对这个类添加例子，我想把例子统一放在d盘的examples文件夹下统一管理，那么路径应该是这样的：d:\examples\cn\pboy\control\ButtonExample.as，然后在命令行工具下把当前盘符设为d:\powerboy>，通过以下命名就可以编译了：asdoc -source-path . -doc-sources . -examples-path d:\examples
(责任编辑：admin) |
织梦二维码生成器
------分隔线----------------------------
