Question

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

现在我需要用Javadoc样式做一个文档，我试着运行Javadoc。我想也许，因为：“JS版本也可以调用和重用任何Java代码或库，因此您可以拥有JS的简单性，但在需要时也可以使用Java的强大功能。”它会工作，但我得到了这个：

>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

这是我一步一步回答我是如何做到这一点的，因为运行jsdoc-toolkit对.sah-files不起作用。前提条件是您已经下载并安装了java：http://www.java.com/de/download/windows_xpi.jsp

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

SAHI公司＆＃39; s .sah-files可以转换为.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

我不建议下载node.js并使用npm在Windows 7上安装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样式文档？

2 个答案: