JavaScript 文档生成器 Cloud9 IDE
JavaScript Documentation generator Cloud9 IDE
背景
我刚刚在 cloud9 IDE 完成了一个 HTML5 的小项目。我的项目由一个 index.html
文件、3 个 JavaScript 文件和一个自定义 styles.css
文件组成。
我知道我无法记录 HTML 和 CSS,但由于我的项目的核心是其中的 JavaScript,我想记录它。
研究
出于这个原因,我搜索了如何使用 JavaScript 文档生成器工具,例如 JSDocs, Docco, Dox and Esdoc. I also read articles on the matter (comparison between JavaScript documentation tools) and I even gave a look at Naturaldocs。
问题
这里的主要问题是(据我所知)这些工具(Naturaldocs 除外)都会根据我的文件已有的文档生成漂亮的 HTML 和 Markdown 页面。他们阅读我添加的评论,然后根据评论生成文档。
这不是我要找的。
我需要什么?
我正在寻找类似于插件 Ghostdoc and Atomineer 的评论功能的功能,您可以在其中按下组合键,插件会使用样板代码记录整个文档,从而避免麻烦。
最后的笔记
我使用 npm
安装了所有以前的工具(Naturaldocs 除外)。也许我错过了一些东西,但我没有找到任何工具可以完成 Ghostdoc 和 Atomineer 的功能,而且我无法在 cloud9-ide 使用的 ACE 编辑器中安装任何这些插件 (afaik).
TL;DR
有人知道在 Cloud9 IDE 中记录 JavaScript 文件的方法吗?
遗憾的是,经过研究,我得出结论,没有工具可以根据JavaScript代码自动生成文档。您必须手动记录所有内容,然后选择众多现有工具中的一种来生成 HTML 页面或类似内容。
我最终使用了 JSDoc,因为它的文档标准易于访问且文档相对完整。
希望这对与我有相同背景的其他人有所帮助。
此外,我还在官方论坛上创建了一个功能请求:
希望有人会看到它并从中做出一些东西。
ace没有插件,但是有http://smartcomments.github.io/这样的cli工具,你也可以在cloud9上使用。
背景
我刚刚在 cloud9 IDE 完成了一个 HTML5 的小项目。我的项目由一个 index.html
文件、3 个 JavaScript 文件和一个自定义 styles.css
文件组成。
我知道我无法记录 HTML 和 CSS,但由于我的项目的核心是其中的 JavaScript,我想记录它。
研究
出于这个原因,我搜索了如何使用 JavaScript 文档生成器工具,例如 JSDocs, Docco, Dox and Esdoc. I also read articles on the matter (comparison between JavaScript documentation tools) and I even gave a look at Naturaldocs。
问题
这里的主要问题是(据我所知)这些工具(Naturaldocs 除外)都会根据我的文件已有的文档生成漂亮的 HTML 和 Markdown 页面。他们阅读我添加的评论,然后根据评论生成文档。
这不是我要找的。
我需要什么?
我正在寻找类似于插件 Ghostdoc and Atomineer 的评论功能的功能,您可以在其中按下组合键,插件会使用样板代码记录整个文档,从而避免麻烦。
最后的笔记
我使用 npm
安装了所有以前的工具(Naturaldocs 除外)。也许我错过了一些东西,但我没有找到任何工具可以完成 Ghostdoc 和 Atomineer 的功能,而且我无法在 cloud9-ide 使用的 ACE 编辑器中安装任何这些插件 (afaik).
TL;DR
有人知道在 Cloud9 IDE 中记录 JavaScript 文件的方法吗?
遗憾的是,经过研究,我得出结论,没有工具可以根据JavaScript代码自动生成文档。您必须手动记录所有内容,然后选择众多现有工具中的一种来生成 HTML 页面或类似内容。
我最终使用了 JSDoc,因为它的文档标准易于访问且文档相对完整。
希望这对与我有相同背景的其他人有所帮助。
此外,我还在官方论坛上创建了一个功能请求:
希望有人会看到它并从中做出一些东西。
ace没有插件,但是有http://smartcomments.github.io/这样的cli工具,你也可以在cloud9上使用。