JavaScript文档生成器Cloud9IDE



背景

我刚刚在cloud9IDE中完成了一个小型HTML5项目。我的项目由一个index.html文件、3个JavaScript文件和一个自定义styles.css文件组成。

我知道我不能记录HTML和CSS,但由于我项目的核心是其中的JavaScript,我想记录它

研究

出于这个原因,我搜索了如何使用JavaScript文档生成器工具,如JSDocs、Docco、Dox和Esdoc。我还阅读了关于这件事的文章(JavaScript文档工具之间的比较),我甚至看了一眼Naturaldocs。

问题

这里的主要问题是(据我所知)这些工具(Naturaldocs除外)都基于我的文件已经有的文档生成了漂亮的HTML和Markdown页面。他们阅读了我添加的评论,然后根据它生成了一个文档

这不是我想要的。

我需要什么

我正在寻找类似pluggins Ghostdoc和Atomineer的注释功能,在这里,你可以按组合键,pluggins会用样板代码记录你的整个文档,让你省去麻烦。

期末票据

我使用npm安装了以前的所有工具(Naturaldocs除外)。也许我错过了一些东西,但我没有找到任何能像Ghostdoc和Atominer那样工作的工具,而且我无法在cloud9ide使用的ACE编辑器中安装任何这些插件(afaik)。

TL;DR

有人知道在Cloud9IDE中记录JavaScript文件的方法吗?

不幸的是,经过研究,我得出结论,没有任何工具可以自动生成基于JavaScript代码的文档。您必须手动记录所有内容,然后从许多现有工具中选择一个来生成HTML页面或类似的东西。

我最终使用了JSDoc,因为它的文档标准很容易访问,而且文档也相对完善。

希望这能帮助到其他和我出身相同的人。


此外,我还在官方论坛上创建了一个功能请求:

  • https://community.c9.io/t/javascript-documentation-generator-cloud9-ide/5918

希望有人能看到它,并从中有所收获。

没有ace插件,但有cli工具http://smartcomments.github.io/,你也可以在cloud9上使用它。

相关内容

  • 没有找到相关文章

最新更新