编写JavaScript库API的文档

时间:2011-07-07 08:27:57

标签: javascript api documentation documentation-generation

我需要为我们的JavaScript库API编写一个文档,并将它们发布为HTML(如jQuery API站点和类似版本)。 我认为有两种方法可以解决这个问题。

  1. 在JavaScript中撰写评论并找到解析它的方法(例如JsDoc ToolkitjGrouseDoc
  2. 手动编写(在wiki中?)
  3. 我正在寻找好的工具来做到这一点。有什么想法吗?

2 个答案:

答案 0 :(得分:1)

您可以将Javadoc注释放在Javascript代码中。在JDK安装中使用Javadoc.exe生成HTML文档。

答案 1 :(得分:0)

Verb似乎很有希望。我跟着它。