ECMAScript 6文档生成器 [英] ECMAScript 6 documentation generators
问题描述
我正在寻找EcmaScript 6的文档生成器。我没有找到一个。
I am looking for a documentation generator for EcmaScript 6. I did not find a single one.
- JSDoc 3不支持< a href =https://github.com/jsdoc3/jsdoc/issues/555> https://github.com/jsdoc3/jsdoc/issues/555
- Docco没有发现
- SmartComments没有发现但不太可能，太小的项目
- 没有找到YuiDoc
- NaturalDocs没有找到但没有关注JavaScript
- 没有找到SphinxDoc
- JSDoc 3 has no support https://github.com/jsdoc3/jsdoc/issues/555
- Docco nothing found
- SmartComments nothing found but unlikely, too small project
- YuiDoc nothing found
- NaturalDocs nothing found but no focus on JavaScript
- SphinxDoc nothing found
那么真的没有文档发生器为ES 6？
So is there really no documentation generator for ES 6 yet?
推荐答案
现在有几个ES6文档生成器。我目前推荐 ESDoc ，因为它是目前最完整的文档生成器。
There are now a few ES6 documentation generators. I currently recommend ESDoc because it is currently the most complete documentation generator.
我将根据需要进行更新。
I will update this as needed.
ESDoc支持JSDoc语法，解析大部分（或全部？）ES6并输出不错 HTML文档。 ESDoc使用 esdoc.json 文件配置，可以记录整个目录。它集成了摩卡用于覆盖生成。还有一个JSON输出。
ESDoc supports JSDoc syntax, parses most (or all?) of ES6 and outputs nice HTML documents. ESDoc is configured using an esdoc.json file and can document whole directories. It integrates Mocha for coverage generation. There is also a JSON output.
Docchi只对一个文件进行操作，并输出一个描述JavaScript代码的JSON文件。它不会创建任何HTML或其他呈现的文档，并声明它不匹配许多AST节点。但是它使用与 Dox 相同的JSON，因此应该可以使用与Dox。
Docchi just operates on one file and outputs a JSON file that describes the JavaScript code. It does not create any HTML or other rendered docs and states that it does not match many AST nodes. But it uses the same kind of JSON as Dox so that it should be possible to use the same viewers as for Dox.
根据 Github问题，JSDoc部分支持ES6，但是错过了许多部分和拒绝文件，例如导出的项目。
According to a Github issue JSDoc supports ES6 partially but it misses many parts and rejects to document for example exported items entirely.
转录是试图编写ES6文档生成器，但最后一次提交是从2015年3月16日起。
Transcription was an attempt to write an ES6 documentation generator but the last commit is from 16 March 2015.
YUIDoc支持ES6部分。
YUIDoc supports ES6 partially.
Documentationjs是一个新的文档在发电机上。它支持ES6，并允许您以标准的JSDoc格式编写您的文档注释。
Documentationjs is a new documentation generator. It supports ES6 and allows you to write your doc comments in standard JSDoc format.
这篇关于ECMAScript 6文档生成器的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
