Rust内容模版

113 阅读1分钟

一、Content/概念

概念

一两句话讲清楚是什么(这里避免过于口语化)

比喻

大白话描述,力争让小白能够明白

真实用例

实际项目中的代码,并附加描述(可找一些跟区块链相关的demo)

# 比如openzeppelin代码

此处解释这段代码

Documentation

能阐释概念的最简单代码demo,简单易懂。

# 此处加注释说明
let a = 1;

FAQ

可能的问题,及解答(可以深入一点,面向有技术基础的同学)。

二、Example/示例代码

代码,以及描述

# this is code

三、Quiz/小测

  • 可以选择题(true/false、单选题)
  • 可以填空题
  • 可以代码题