robotframework脚本中的文档注释

时间:2024-01-27 19:01:03
生成文档命令
python -m robot.libdoc xxx.robot xxx.html
 
语法说明
= 说明 = h2标题,注意第一个等号前有四个空格,==中间文字两边各有一个空格
== 注意事项 = h3标题,注意第一个等号前有四个空格,中间文字两边各有一个空格
| =参数名称= | =参数说明= | 表头,注意第一个|前有四个空格,||中间文字用等号包裹,两边各有一个空格
| ExcuteSQL | select * from persons where age<10 | children | 记录,注意第一个|前有四个空格,||中间文字两边各有一个空格
 
示例
*** Settings ***
Documentation
...    你的描述
...    = 说明 =
...    你的说明
...    使用指定参数示例:
...    | =关键字= | =sql= | =outtable= | =**props= |
...    | ExcuteSQL  | select * from persons where age<10 | children | persist_tag=1 |
...    | ExcuteSQL  | select * from persons where gender=male | men | persist_tag=1 | repartition=1 |
...    == 注意事项 ==
...    公共关键字库,不可变更覆盖
...    == 版本记录 ==
...    2020.11.11 v0.1 created by xxxxx
 
*** Keywords ***
ExcuteSQL
    [Documentation]
    ...    第一行说明,
    ...    第一行太长,第二行说明
    ...    参数说明:
    ...    | =参数名称= | =参数说明= |
    ...    | _sql_ | 查询SQL |
    ...    | _outtable_ | 输出的表名 |
    ...    | _**props_ | 其他控制参数,如persist_tag=1 |
    ...    示例:
    ...    | =关键字= | =sql= | =outtable= | =**props= |
    ...    | ExcuteSQL | select * from persons where age<10 | children |
    ...    | ExcuteSQL | select * from persons where gender=male | men | persist_tag=1 | repartition=1 |
    [Arguments]    ${sql}    ${outtable}    &{props}
    [Return]    ${dataset}
    ${dataset}=    otherKeyWord    ${sql}    ${table}    &{props}
 
 
生成的html文档效果如下: