跳到主要內容

How to create the robotframework document?

Introduction

當實做的Keyword一多,你的Team Member可能就會說: 有沒有像JavaDoc的東西阿? 有滴。RobotFramework提供了libdoc tool讓你可以將resource或library檔案變成你想要的文件。

Script for libdoc command

我這是為PortableRobotFramework而打造的,如果你是直接安裝RobotFramework,可直接跳至下一節。如果你是使用java library的方式,必須要有tools.jar,我將它與robotframework.jar放一起,你也可以直接修改TOOLSPATH變數到jdk內的tools.jar位置。我將libdoc.sh與robotframework.jar放一起,這也是看你個人喜好,但別忘記要改對路徑關係喔!

#!/bin/sh
FULLPATH=`dirname "$0"`/`basename "$0"`
SHPATH=`readlink -f "$FULLPATH"`
BASEPATH=`dirname "$SHPATH"`

TOOLSPATH=$BASEPATH/tools.jar
RFPATH=$BASEPATH/robotframework.jar

CLASSPATH=$TOOLSPATH:$RFPATH
java -cp "$CLASSPATH" org.robotframework.RobotFramework libdoc "$@"

How to use?

libdoc是允許python、java與resource三種lib file。python我沒試驗過,其它兩種可參考我的指令:

# 確認所有參數
./libdoc.sh -h
# 產生java libraries的doc,並設定版號為1.0
./libdoc.sh -v 1.0 HotKeyUtil.java HotKeyUtil_doc.html
# 產生resource file的doc,並設定版號為1.0
./libdoc.sh -v 1.0 HotKeyUtil.html HotKeyUtil_doc.html

執行後,應該會看到如下圖的網頁。版本資訊、API描述或Scope等,這些是看你Lib怎實做的。之前曾介紹過實做test library by java,可以回去複習看看!


你也可以透過-f<html|xml>產生其它格式的文件,而-v如果你沒指定,它就會使用library內所定義的。

看完文章後動手試試看吧!

留言

這個網誌中的熱門文章

PostgreSQL - Unattended installation on windows

Introduction 要將別人軟體包裝到自己軟體中,不可或缺的東西就是Unattended installation。以Unattended installation來說,我們可以選擇透過Installer的silent mode安裝,也可以透過把目標軟體做成portable的版本。本篇文章分享這兩種方法,教導大家如何將PostgreSQL透過Unattended installation方式安裝到目標系統成為service。 Note. 本篇以PostgreSQL 10.7為例。 Install with installer Tips 安裝程式或反安裝程式的參數,除了可以直接上官網搜尋Installation User Guide以外,也可以直接使用help參數查詢: postgresql- 10.7 - 2 -windows-x64.exe --help Windows安裝程式主要有EnterpriseDB與BigSQL兩種。BigSQL版本安裝元件是透過網路下載且支援參數不如EnterpriseDB版本多,以我們需求來說,我們傾向於使用EnterpriseDB版本。接下來分享給大家安裝與反安裝方法。 Installation @ echo off set INSTALL_DIR =C:\postgres10 set INSTALLER =postgresql- 10.7 - 2 -windows-x64.exe   rem options for installation set SSMDB_SERVICE =postgresql- 10 set MODE =--unattendedmodeui none --mode unattended   set DB_PASSWD =--superpassword postgres set DB_PORT =--serverport 5432   set SERVICE_NAME =--servicename % SSMDB_SERVICE %   set PREFIX =--prefix "%INSTALL_DIR%" set DATA_DIR =--datadir "%INSTALL_DIR%\data"   set OPTIONS =

How to install RIDE on Windows?

Introduction 多年沒在Windows上開發RobotFramework,趁著這次整理一下RIDE安裝方法。 目前RIDE最新版本與Python對應版本如下: (3.6 < python <= 3.11) Install current released version (2.0.8.1) with: pip install -U robotframework-ride 安裝Python 直接到Python官網找尋最新的3.11版本,我使用3.11.9: link 。安裝就是一直下一步而已。 安裝wxPython 每次安裝RIDE最困難的都是wxPython。看了一下 官網 描述,我就姑且相信一下: 接著進入下 載頁面 就有安裝教學。基本上就是到Python目錄下的Scripts直接執行以下command: pip install -U wxPython 安裝RIDE 接著就如RIDE官網所說,執行以下command: pip install -U robotframework-ride 啟動RIDE 直接在相同目錄下執行ride就可以啟動了,你也可以直接在桌面建ride連結,加快下次啟動時間。 沒想到這次這麼順利就安裝完成了。因為我是使用java去啟動robot framework,就不特別講要怎麼使用pip安裝robot framework了。

Hello World!

即將要搬家,因此舊網頁內容將慢慢轉移至Blogger。 如果要存取舊網頁,可以使用以下連結: https://wiki.tonylin.idv.tw/dokuwiki/doku.php