我一直在用AS3开发一个我想要发布的框架,但是首先我显然需要为它准备一些文档。
我注意到很多网站都有与Adobe相同的布局、功能等,这让我相信有一些开源的东西可以用来创建在线文档。
以下是一些例子:
有人能为我指出正确的方向,我可以用它来准备在线文档吗?
理想情况下,该系统将专门适用于ActionScript 3中的文档。在自动生成文档方面,我也没有要求--如果有什么东西看起来/工作得很好,我很乐意手动创建文档(前提是它附带了一些工具,可以轻松地添加类、参数等)。
发布于 2011-06-17 02:27:39
Adobe有一个名为ASDoc的免费工具。它生成遵循正式Adobe模式的文档。坦白说,这是不值得的。ASDoc工具是错误的和不可靠的。如果它很难找到一个导入,如果没有使用一个导入,一个注释没有被正确的格式化,或者你的源代码以任何一种意想不到的方式展开,它就会崩溃。
我的公司已经损失了50多个开发时间(有几个人试图让几个不同的项目开始工作,但失败了),试图绕过这些限制和我们的解决方案?我们使用了NaturalDocs (一个JavaDoc编译器)。它完美吗?不是的。它的输出与ASDoc相当吗?从某种意义上说,它并不是那么整洁,如果它对事物的处理方式有一点不同,那就更好了,但是它可以显示文档。
https://stackoverflow.com/questions/6380742
复制相似问题