Lee's BlogLee's Blog
Article
Project
Category
Tag
Timeline
Article
Project
Category
Tag
Timeline
  • demo vs example

demo vs example

demo vs example

  • demo:侧重可直接运行的演示程序,完整小项目,用来展示效果;
  • example:侧重代码片段 / 示例,讲解 API、用法,不一定完整可独立跑。

日常写文档、注释看场景选:

✅ example(推荐技术文档、API 文档)

含义:用法示例、样例代码 特点:短小,片段化,只展示核心逻辑,不一定带完整入口、依赖。 适用:

  • SDK / API 文档里的代码片段
  • 注释、教程里 “怎么调用这个函数”
  • 变量名 / 文件夹名:examples/(开源项目标准目录名!)

开源项目几乎统一用 examples 放示例代码,不用 demos

示例:

See the example below.

// example code

✅ demo(演示项目)

含义:演示 Demo,成品小样 特点:完整工程,能直接启动运行,用来展示完整功能效果。 适用:

  • 独立可运行的演示项目
  • 前端展示页面、完整可启动的小应用
  • 给客户演示效果的工程

示例:

A demo project to show the full capability. 目录:demo/

快速区分口诀

  1. 只是一段代码片段,教怎么用 → example
  2. 一整个能跑起来的小项目,看效果 → demo

命名规范建议(工程里)

  • 放零散代码样例文件夹:examples/(行业惯例优先)
  • 完整可运行演示项目:demo/

小补充:sample 介于两者之间,偏 “采样样例”,一般不常用做目录名。

Last Updated: 10/12/26, 6:01 AM
Contributors: zlx01

CC BY-NC-SA 4.0 © 2021~present 粤ICP备2021090228号