Software Documentation Tools之Markdown

Markdown是一种轻量级标记语言,旨在简化文本格式化过程,使其易于阅读和编写。通过使用简单的标点符号,Markdown实现了强调、列表、引用等功能,无需复杂的HTML代码。它适用于创建README文件、在线论坛帖子以及使用纯文本编辑器进行丰富文本编辑。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Markdown is a lightweight markup language with plain text formatting syntax designed so that it can be converted to HTML and many other formats using a tool by the same name. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

概括一句话:“Markdown的目标是实现「易读易写」。”

人性化设计

Markdown的语法全由标点符号所组成,并经过严谨慎选,是为了让它们看起来就像所要表达的意思。像是在文字两旁加上星号,看起来就像强调。Markdown的清单看起来,嗯,就是清单。假如你有使用过电子邮件,区块引言看起来就真的像是引用一段文字。

Markdown与HTML的关系

Markdown的语法有个主要的目的:用来作为一种网路内容的写作用语言

Markdown不是要来取代HTML,甚至也没有要和它相似,它的语法种类不多,只和HTML的一部分有关系,重点不是要创造一种更容易写作HTML文件的语法,我认为HTML已经很容易写了,Markdow的重点在于,它能让文件更容易阅读、编写。HTML是一种发布的格式,Markdown是一种编写的格式,因此,Markdown的格式语法只涵盖纯文字可以涵盖的范围。不在Markdown涵盖范围之外的标签,都可以直接在文件里面用HTML撰写。不需要额外标注这是HTML或是Markdown,只要直接加标签就可以了。

举例来说,在Markdown文件里加上一段HTML表格:

This is a regular paragraph.

Foo

This is another regular paragraph.

关于Markdown的使用方法可以参考这里

*** Settings *** Documentation Perform undocking and docking test Library Process Library BuiltIn Library OperatingSystem Resource common/core_automation.resource Library common.PrepareDutForRun Resource common/permanent_run.resource Resource monitor.robot Resource robot_helper/network.robot Resource battery.robot Suite Setup Current Suite Setup Suite Teardown Current Suite Teardown Test Teardown Teardown Testcase Test Setup Init Testcase *** Keywords *** Init Testcase Send Command To Robot command_restart_robot_service Wait Until Keyword Succeeds 5 sec 1 sec Check Systemd Service Readiness robot BuiltIn.Sleep 10 sec Teardown Testcase Run Keyword If Timeout Occurred Set Timeout Variable *** Test Cases *** Perform Fast Basic Cleaning Cycle [Documentation] Perform basic run consisting of undocking and docking. ... The cleaning run will be paused and canceled after 20 sec. Log Mode = %{CLEANINGMODE} console=yes ${error} = command_to_rpc_thin_client start Wait Until Keyword Succeeds 20 sec 2 sec Robot Undocking BuiltIn.Sleep 10 sec ${error} = command_to_rpc_thin_client pause BuiltIn.Sleep 5 sec ${error} = command_to_rpc_thin_client return Wait Until Keyword Succeeds 2 min 5 sec At Base Check *** Keywords *** Current Suite Setup Log Starting Suite Setup console=yes Set Suite Variable ${TIMEOUT_OCCURED} False Set Suite Variable ${DOCKING_CORRECT} True ICMP Ping %{DUTIP} ${5} # Keep "Check Size..." and "Prepare DUT" active for navigation tests! Otherwise results are skewed and incomplete! If needed, please create new test, or If-Else Switch. # "Check Size..." reduces filesize, otherwise we could hit a soft limit with blackbox file size # "Prepare DUT" also gathers information of the robot: What software is running, is this correct with database, is it in Error State, can the robot even start a cleaning run and is battery threshold reached? Check Size From Journal And Remove If Greater Than Threshold Prepare DUT Prepare Thin RPC Tools Set Timeout Variable Set Suite Variable ${TIMEOUT_OCCURED} True Current Suite Teardown Log Suite Teardown console=yes Log Timeout occured: ${TIMEOUT_OCCURED} console=yes IF ${TIMEOUT_OCCURED} == False Wait For Being Carried Home END Download Logfiles ${sequence} = Get Serialized Sequence %{DUTIP} Log ${sequence} ${event_counts} = Get Serialized Event Counts %{DUTIP} Log ${event_counts} ${emmc_data} = Get Emmc Health Log ${emmc_data} Write Emmc Data To Tsdb %{DUTIP} %{FIRMWAREVERSION} Log ${DOCKING_CORRECT} Write Automation Run Stats %{DUTIP} ${DOCKING_CORRECT} %{TEST_UUID}
最新发布
04-03
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值