MarqdoEXECUTABLE KNOWLEDGE

Functions and named callsok

structure/02-function.mq.md

文档

怎样读这份可执行文档

正文说明意图,标记指出哪些片段会执行。遮蔽只在正文显示动作说明,实际逻辑放在侧注;阅读、展开与定位都不会运行代码。

标记阅读含义
无标记文字作者的解释,按普通 Markdown 阅读。
空行分隔叙述与结构,不是计算步骤。
# / ##一级标题声明对象或入口,更深标题声明函数;说明按钮可查看输入、返回与依据。
>调用函数;实际执行结果另有标注。
1. 递增按条件选择分支,不是普通编号说明。
-重复或遍历结构;迭代选择器只切换已有运行记录。
+ `名`兼容的显式形参;新库优先在叙述中声明参数,标题下的表格解释契约。
GFM 表未绑定的契约表是说明;绑定表按列、行和 @ 形态构成数据。
```lang代码块;绑定的外语代码与普通示例区分展示,数学公式另有公式卡片。
--- / ***分隔内容,不能把分隔线当作函数返回。
<!-- marqdo-out -->程序写回的结果,区别于作者原始正文。
`名`叙述中的参数或变量;默认值跟在名称之后。
**…**执行语句:赋值、调用或计算;不是打印,也不是返回。
*…*返回表达式;句中以返回、Return 等明确引出。
*None* / ****显式返回空值或结束当前函数。
[键](集合)正文显示描述,侧注按函数与参数、可跳转链接、结构化内容展示括号内的细节;空括号表示待补充实际逻辑。阅读不会执行调用。classic 模式保留旧链接取元。
修饰… [函数] …兼容的带修饰调用;不能把任意普通链接当作执行授权。
集合[^键]兼容的脚注取元;当前库优先用 access 读取集合。
*仅* / **说明**普通强调仍属于文字;界面按真实解析结果区分强调、语句与返回。

main

说明
返回类型说明
resultanyNone; execute this page's documented steps in order and observe their output or stated effects

Headings expose callable definitions. The input contract sits directly below the heading, and its body names the recipient in prose; callers supply that value by name.

Call with > and named args param=value:

We now .
函数调用Call greet
greet
who
World
原始写法
> greet who="World"
源码说明 · 不是运行结果

greet

说明
who=World
参数类型默认说明
whoanyrequiredRecipient name inserted into the greeting
返回类型说明
resultanyNone; display the computed content on stdout

Input who, used by the steps below.

We now .
函数调用Display this step's result
print
text
Hello `who`!
原始写法
> print text="Hello `who`!"
源码说明 · 不是运行结果
Functions
Variables
  • description text
    Callable headings, narrative inputs and readable named calls
  • markup text
    occlusion
  • title text
    Functions and named calls
可执行知识 · 输入、返回与依据

这份文档怎样成为可调用的知识

2 个知识单元 · 4 个结构步骤。先读输入、返回与调用边界,再按需查看依赖和依据。

以下来自静态分析,不代表程序已经运行、测试通过或内容已获领域确认。实际运行见正文标注与“运行与结果”。

main程序入口
回到正文 · 第 7 行

这是程序入口或对象声明。成员函数的输入输出在各自说明中列出。

源码中的返回契约

any · None; execute this page's documented steps in order and observe their output or stated effects

调用边界

输出文本。权限由实际运行入口授予;静态副作用信息不等于运行许可。

依赖哪些知识

当前有哪些依据

语法与引用
检查通过;检查通过
契约检查
尚未检查
测试记录
没有可用记录
内容来源
尚无已核验证据
领域审阅
尚未进行领域审阅
查看本单元的结构步骤

这是源码结构,不是实际执行时序;正文引用不会因阅读而执行。

  1. 调用Call greet
  2. 正文引用Call greet
技术详情:身份、摘要与原始状态
目标标识
mq://public/structure%2F02-function/type/main
制品摘要(未检查锁定状态)
sha256:77349788a1c12720b8c442e801239557e3d0aee6015c2315c8170e16e983940c
依赖标识
mq://public/structure%2F02-function/function/main/greet
原始验证状态
parse: passed; resolve: passed; contract: unchecked; execution: not_run; tests: unknown; evidence: unverified; domain: unreviewed
main.greet函数
回到正文 · 第 19 行

需要什么输入

参数类型提供方式含义
whoany必填Recipient name inserted into the greeting

返回什么

any · None; display the computed content on stdout

调用边界

输出文本。权限由实际运行入口授予;静态副作用信息不等于运行许可。

当前有哪些依据

语法与引用
检查通过;检查通过
契约检查
尚未检查
测试记录
没有可用记录
内容来源
尚无已核验证据
领域审阅
尚未进行领域审阅
查看本单元的结构步骤

这是源码结构,不是实际执行时序;正文引用不会因阅读而执行。

  1. 调用Display this step's result
  2. 正文引用Display this step's result
技术详情:身份、摘要与原始状态
目标标识
mq://public/structure%2F02-function/function/main/greet
制品摘要(未检查锁定状态)
sha256:b16f2b7b64100a745615c98caba73b05558341d45f98538ccc03530c79f6acf4
依赖标识
原始验证状态
parse: passed; resolve: passed; contract: unchecked; execution: not_run; tests: unknown; evidence: unverified; domain: unreviewed

运行与结果

Hello World!
完整源码
---
markup: occlusion
title: Functions and named calls
description: Callable headings, narrative inputs and readable named calls
---

# main

| 返回 | 类型 | 说明 |
|---|---|---|
| result | any | None; execute this page's documented steps in order and observe their output or stated effects |

Headings expose callable definitions. The input contract sits directly below the heading, and its body names the recipient in prose; callers supply that value by name.

Call with `>` and named args `param=value`:

We now **[Call greet](> greet who="World")**.

## greet

| 参数 | 类型 | 默认 | 说明 |
|---|---|---|---|
| who | any | required | Recipient name inserted into the greeting |

| 返回 | 类型 | 说明 |
|---|---|---|
| result | any | None; display the computed content on stdout |
Input `who`, used by the steps below.

We now **[Display this step's result](> print text="Hello `who`!")**.

Variable