28 lines
1.3 KiB
Markdown
28 lines
1.3 KiB
Markdown
# 基础应用文档撰写说明
|
|
|
|
适用文件：`doc/基础应用/<中文名>(目录名).md`。一个 `src/app` 子目录一篇。
|
|
|
|
## 目录
|
|
|
|
- [1. 功能定义](#1-功能定义)
|
|
- [2. 使用示例](#2-使用示例)
|
|
- [3. 数据流与时序](#3-数据流与时序)
|
|
|
|
示例见 [基础应用(示例)](./基础应用(示例).md)。
|
|
|
|
## 1. 功能定义
|
|
|
|
一段话说明这个基础应用做什么。下列出对外入口：类或函数、文件路径、各自负责的事。
|
|
|
|
## 2. 使用示例
|
|
|
|
给出调用这个入口的代码，并注明代码所在文件。示例表现功能模块或路由怎样使用它。一个入口一段示例；入口很小且调用方式相同时可以合在一段里。
|
|
|
|
## 3. 数据流与时序
|
|
|
|
一条行为优先用时序图。时序图已经能说明调用顺序时，不要再画数据流图。数据流图只在时序图表达不了数据经过哪些对象时再补。图中只用本目录的类名、函数名、方法名。图下用中文复述这条路径。
|
|
|
|
本节标题按实际采用的图来写。只有时序图时，标题为「时序」。
|
|
|
|
不画功能模块的调用链，例如 `SecurityViewModel` 到 `SecurityApplication`。不把其他基础应用的内部步骤画进本篇。功能模块何时调用这些入口，由功能模块文档的时序图说明。使用示例里的代码片段可以来自调用方。
|