编写文档 - 在线显示文档的开源解决方案?

时间:2011-06-17 02:19:29

标签: actionscript-3 frameworks documentation

我一直在研究AS3中我想要发布的框架,但首先我显然需要为它准备一些文档。

我注意到很多网站都有与Adobe Livedocs相同的完全相同的布局,功能等,这让我相信有一些开源的东西用于创建在线文档。< / p>

以下是一些例子:

  1. http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/
  2. http://papervision3d.googlecode.com/svn/trunk/as3/trunk/docs/index.html
  3. http://www.fisixengine.com/api/
  4. 是否有人能够指出我可以用来准备在线文档的工具的正确方向?

    理想情况下,该系统特别适合 ActionScript 3 中的文档。我没有自动生成文档的要求 - 如果有什么看起来/工作得很好我很乐意手动创建文档(前提是它附带了轻松添加类,参数等的工具) )。

1 个答案:

答案 0 :(得分:1)

Adob​​e有一个名为ASDoc的免费工具。它生成遵循官方Adobe模式的文档。坦率地说,它不值得。 ASDoc工具有缺陷且不可靠。如果它很难找到导入,如果没有使用导入,评论格式不正确,或者您的源代码以任何意外的方式展开,它就会中断。

我的公司已经失去了超过50个开发人员的时间(一些人试图让几个不同的项目工作并失败)试图解决这些限制和我们的解决方案?我们使用了NaturalDocs(JavaDoc编译器)。它完美吗?是否与输出中的ASDoc相当?排序,它不是那么整洁,如果它对待事情有点不同会很好,但它可以显示文档。