Как создать Javadoc Style Documentation для скриптов SAHI?

Question

я написал все мои тесты с использованием Сахи-скрипт, так как он является рекомендуемым способом работы с этим инструментом: 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 ?

2.) Если да, то как вы делали это шаг за шагом?

Answer 1

Код Sahi находится в Javascript, хорошо обертка над javascript. Вы можете использовать jsdoc3 (https://github.com/jsdoc3/jsdoc) для создания документации стиля javadoc для ваших скриптов sahi. Если вы проверяете старые версии Sahi (около 5.2), есть файл apis.sah, где присутствует документация стиля jsdoc3.

Answer 2

Вот мой пошаговый ответ, как я это сделал, поскольку запуск jsdoc-toolkit не работал на .sah-файлах. Предпосылкой является то, что вы скачали и установили Java: http://www.java.com/de/download/windows_xpi.jsp

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

.sah-файлы Сахи»s могут быть преобразованы в .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 и использовать НПМ для установки JSDoc на Windows 7, потому что вы будете работать на много вопросов, как я сделал: 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 docmentation здесь: http://usejsdoc.org/index.html