如何为 SAHI 脚本生成 Javadoc 样式文档？

Question

我已经使用 sahi-script 编写了所有测试，因为这是使用此工具的推荐方式： https://sahipro.com/docs/using-sahi/recommended-usage.html#Language%20Recommendation

现在我需要做一个 Javadoc 风格的文档，我尝试运行 Javadoc。我想也许吧，因为："The JS version can also call and reuse any Java code or libraries, so you can have the simplicity of JS but also use the power of Java when needed." 它会起作用，但我却得到了这个：

>javadoc baum.sah
>Loading source files for package baum.sah...
>javadoc warning: No source files for package baum.sah
>Constructing Javadoc information...
>javadoc warning: No source files for package baum.sah
>javadoc error: No public or protected classes found to document.
>1 error
>2 warnings

我的问题是：

1.) 有什么方法可以获得 Javadoc 风格的文档而不必重写 Java 中的所有 SAHI 脚本代码？

2.) 如果是，你是如何一步步做到的？

Answer 1

Sahi 代码在 Javascript 中，很好地包装了 javascript。您可以使用 jsdoc3 (https://github.com/jsdoc3/jsdoc) 为您的 sahi 脚本生成 javadoc 样式的文档。如果你检查旧版本的 Sahi（大约 5.2），有一个名为 apis.sah 的文件，其中存在 jsdoc3 样式文档。

Answer 2

这是我一步步回答我是如何做到的，因为运行ning jsdoc-toolkit 不能处理 .sah 文件。前提是你已经下载安装java:http://www.java.com/de/download/windows_xpi.jsp

1.)convert .sah-files into .js-files

Sahi 的 .sah 文件可以转换为 .js 文件: https://sahipro.com/docs/faq/eclipse-integration.html

2.)download a js-toolkit and unzip it

最好按照这些简单的说明进行操作：https://code.google.com/p/jsdoc-toolkit/wiki/InstallJsdoc

我不建议在 Windows7 上下载 node.js 和使用 npm 安装 jsdoc，因为你会运行像我一样遇到很多问题：https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows

3.)open a cmd and run the command where you unzipped the jsdoc-toolkit

path_where_unzipped_folder\jsdoc_toolkit-2.4.0\jsdoc-toolkit>java -jar jsrun.jar app/run.js your_path_to_file\anyfile.js -t=templates\jsdoc 


4.)look up your generated documentation html files here:

path_where_unzipped_folder\jsdoc_toolkit-2.4.0\jsdoc-toolkit\out\jsdoc

在此处查找 JSDoc 文档用法：http://usejsdoc.org/index.html

如何为 SAHI 脚本生成 Javadoc 样式文档？

How do I generate Javadoc Style Documentation for SAHI scripts?

javascript

java

documentation

javadoc

sahi