通用文档工具 - Java（Spring MVC），Javascript [关闭]答案

【问题标题】：Universal documentation tool - Java (Spring MVC), Javascript [closed]通用文档工具 - Java（Spring MVC），Javascript [关闭]
【发布时间】：2015-01-26 09:31:51
【问题描述】：

我有一个完整的 Java (Spring MVC) 后端和 Javascript (Jquery) 前端应用程序。我开始这个项目时根本没有考虑文档，现在我被要求为其编写文档。从我所读到的 javadoc 是使用 java 的方式，但是 javascript 部分呢？我希望代码中的所有类和方法都有类似的格式。

我的问题是：有什么工具可以帮助我记录 java 和 javascript 代码吗？

提前致谢！

【问题讨论】：

标签： java javascript jquery spring-mvc javadoc

【解决方案1】：

我们对 Spring 代码使用 JavaDOC，对 ajax 代码使用 JSDoc。它让我们受益匪浅，因为我们能够在开发大量文档供外部使用的同时评论代码的相关部分。

试一试，看看效果如何。

【讨论】：