开发者

Writing documentation for our JavaScript libraries API [closed]

开发者 https://www.devze.com 2023-03-18 09:19 出处:网络
Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines. It is not currently accepting answers.
Closed. This question is seeking recommendations for books, tools, software libraries, and more. It does not meet Stack Overflow guidelines. It is not currently accepting answers.
开发者_Go百科

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

I need to write a documentation for our JavaScript libraries API and publish them as HTML (like the jQuery API site and similar). I think there are two ways to tackle this task.

  1. Write comments in the JavaScript and find a way to parse it (like JsDoc Toolkit or jGrouseDoc)
  2. Write it manually (in a wiki?)

I'm looking for good tools to do it. Any ideas?


You can put Javadoc comments in Javascript code. Use Javadoc.exe in the JDK installation to generate the HTML documentation.


Verb seems promising. I'm following it.

0

精彩评论

暂无评论...
验证码 换一张
取 消