How to create the robotframework document?

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

我這是為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 "$@"

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內所定義的。

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

• User Guide

---