童雷 ·Markdown 綜合實例
1. 前言
本節(jié)我們綜合運用前面章節(jié)的內(nèi)容，完成一篇具有格式的論文。
論文以《XX 管理系統(tǒng)設計與實現(xiàn)》作為題目，包含畢業(yè)論文所需的主要對象，如標題、段落、設計圖、表格、引用等。只為體現(xiàn)格式與排版效果，內(nèi)容純屬虛構。
2. 語法詳解
2.1 文章結構規(guī)劃
一篇完整的論文需要包含封面、摘要、目錄、正文（緒論、需求分析、概要設計、功能實現(xiàn)、系統(tǒng)測試）、結束語、致謝、參考文獻。我們用一級標題表示以上內(nèi)容。方式如下：
實例 1：
用一級標題劃分文章結構，并用注釋簡述該部分的核心內(nèi)容。
<!-- 封面 -->
# 摘要
<!-- 中文和英文摘要，包含關鍵詞 -->
# 目錄
<!-- 使用 [TOC] 生成目錄 -->
# 第一章 緒論
<!-- 描述寫作目的，以文字為主，引用他人數(shù)據(jù) -->
# 第二章 需求分析
<!-- 包含餅圖 -->
# 第三章 概要設計
<!-- 包含流程圖、類圖、數(shù)據(jù)庫表等 -->
# 第四章 功能實現(xiàn)
<!-- 穿插大量的圖片和源代碼 -->
# 第五章 系統(tǒng)測試
<!-- 以表格為主 -->
# 結束語
<!-- 純文字部分 -->
# 致謝
<!-- 純文字部分 -->
# 參考文獻
<!-- 尾注 -->
其渲染效果如下：
2.2 摘要部分
摘要部分通常為一大段普通文字加關鍵詞，其中「關鍵詞」三個字要加粗強調顯示。
實例 2：
摘要的實例。
# 摘要
這里插入任意的文本內(nèi)容。
...
這里插入任意的文本內(nèi)容。
**關鍵詞**：編輯器，格式化，Markdown。
其渲染效果如下：
2.3 緒論部分
緒論部分已文字為主，適當增加引用。
實例 3：
緒論部分的實例。
# 第一章 緒論
## 1.1 課題背景
[這是一段正文內(nèi)容]
>引用他人的論點論據(jù)，用來佐證本文的背景及意義。
>
>——引文出處，適當增加尾注[^1]
[這是一段正文內(nèi)容]
## 1.2 信息化管理
## 1.3 系統(tǒng)設計目的和內(nèi)容
[^1]: 緒論尾注 1 的內(nèi)容。
其渲染效果如下：
2.4 需求分析
需求分析一般包含可行性分析、業(yè)務需求、數(shù)據(jù)項分析。
實例 4：
需求分析實例。
# 第二章 需求分析
## 2.1 可行性分析
### 2.1.1 技術可行性
同類產(chǎn)品技術解決方案：
- XX 公司實現(xiàn)的產(chǎn)品，用了 XX 技術；
- XX 公司實現(xiàn)的產(chǎn)品，用了 XX 技術；
- XX 公司實現(xiàn)的產(chǎn)品，用了 XX 技術。
### 2.1.2 經(jīng)濟可行性
?```mermaid
pie title 市場分析
"已改造" : 386
"未改造" : 85
?```
<center>圖1：市場分析圖</center>
### 2.1.3 管理可行性
## 2.2 需求分析
### 2.2.1 功能需求
- 功能點1
- 子功能點 1-1
- 子功能點 1-2
- 子功能點 1-3
- 功能點2
- 子功能點 2-1
- 子功能點 2-2
- 功能點3
### 2.2.2 環(huán)境需求
| 需求項 | 需求指標 |
| -------- | --------- |
| 操作系統(tǒng) | CentOS 7 |
| 數(shù)據(jù)庫 | Mysql 5.7 |
| 內(nèi)存 | 8G |
| 硬盤 | 100G |
## 2.3 數(shù)據(jù)項分析
數(shù)據(jù)表整理
| 數(shù)據(jù)對象 | 簡述 | 來源 | 核心數(shù)據(jù)項 | 主鍵 |
| -------- | ------------------ | -------- | ------------ | ------ |
| 管理員表 | 保存系統(tǒng)管理員信息 | 注冊 | 登錄名 | 登錄名 |
| 學生表 | 保存學員信息 | 批量導入 | 姓名、學號 | 學號 |
| 老師表 | 保存教職工信息 | 批量導入 | 姓名、職工號 | 職工號 |
| 部門表 | 保存部門、班級信息 | 批量導入 | 名稱、編號 | 編號 |
其渲染效果如下：
2.5 概要設計
設計部分以圖表形式的內(nèi)容最多。
實例 5：
# 第三章 概要設計
## 3.1 數(shù)據(jù)表設計
**管理員表**
管理員表的描述文字。
*表1：管理員表結構*
| 列名 | 數(shù)據(jù)類型 | 長度 | 非空 | 主鍵 |
| -------- | ----------- | ---- | ---- | ---- |
| id | UUID | 64 | √ | √ |
| account | VARCHAR(32) | 32 | √ | |
| password | VARCHAR(32) | 32 | | |
**學生信息表**
學生信息表的描述文字。
*表2：管理員表結構*
| 列名 | 數(shù)據(jù)類型 | 長度 | 非空 | 主鍵 |
| -------- | ----------- | ---- | ---- | ---- |
| id | UUID | 64 | √ | √ |
| name | VARCHAR(32) | 32 | √ | |
| age | Integer | 8 | | |
## 3.2 數(shù)據(jù)表關系圖
?```mermaid
classDiagram
學員表 --> 部門表 : 關聯(lián)
職工表 --> 部門表 : 關聯(lián)
class 學員表 {
id
部門 ID <fk>
}
class 職工表 {
id
部門 ID <fk>
}
class 部門表 {
id
}
?```
<center>圖3-1：數(shù)據(jù)關系表</center>
## 3.3 功能結構圖
?```mermaid
graph LR
XX管理系統(tǒng) --> 管理員登錄
管理員登錄 --> 系統(tǒng)設置
管理員登錄 --> 學員管理
管理員登錄 --> 教師管理
管理員登錄 --> 部門管理
部門管理 --> 增加
部門管理 --> 修改
部門管理 --> 刪除
部門管理 --> 批量導入
?```
<center>圖3-2：功能結構圖</center>
其渲染效果如下：
2.6 功能實現(xiàn)
系統(tǒng)功能實現(xiàn)部分多以代碼和截圖為主。
# 第四章 功能實現(xiàn)
## 4.1 后臺代碼實現(xiàn)
?```java
public class Starter {
public static void main(String[] args) {
System.out.println("Hello world");
}
}
?```
## 4.2 前端代碼實現(xiàn)
前端 HTML 代碼：
?```html
<!DOCTYPE HTML>
<html>
<head></head>
<body>
<p>Hello world.</p>
</body>
</html>
?```
前端腳本代碼：
?```javascript
function main() {
alert("Hello world!");
}
window.onload = main;
?```
## 4.3 配置文件代碼
properties 類型的配置文件：
?```properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/helloworld?characterEncoding=utf8
jdbc.username=root
jdbc.password=root
?```
## 4.4 運行及啟動日志
?```bash
java Starter
---
Hello world
?```
網(wǎng)頁截圖：
<center>圖4-1：訪問效果圖</center>
其渲染效果如下：
2.7 系統(tǒng)測試
系統(tǒng)測試部分多以列表及表格為主。
實例 7：
# 第五章 系統(tǒng)測試
## 5.1 功能點完成情況對照
- [x] 數(shù)據(jù)庫創(chuàng)建
- [x] 后端開發(fā)
- [x] 前端開發(fā)
- [x] 接口聯(lián)調
- [ ] 日志歸檔
## 5.2 測試結果
| 功能點 | 是否測試 | 是否通過 | 備注 |
| ------------ | ---------------------------- | ---------------------------- | ---- |
| 登錄 | <font color="green">√</font> | <font color="green">√</font> | 無 |
| 登出 | <font color="green">√</font> | <font color="red">×</font> | 無 |
| 增加學員信息 | <font color="red">×</font> | <font color="red">×</font> | 無 |
其渲染效果如下：
2.8 參考文獻
參考文獻部分是尾注的匯總。
正文某處[^1]
正文某處[^2]
正文某處[^3]
# 參考 文獻
[^1]: XXX，圖書管理系統(tǒng)設計。北京：北京大學出版社，2008。
[^2]: XXX，師生管理系統(tǒng)設計。北京：清華大學出版社，2009。
[^3]: XXX，軟件工程（三）。北京：郵電大學出版社，2019。
其渲染效果如下：
2.9 為論文增加目錄
在論文的目錄章節(jié)后面插入 [TOC]
# 目錄
[TOC]
其渲染效果如下：
3. 小結
本節(jié)內(nèi)容綜合運用了前述的各個小節(jié)的知識點。
實際應用中，我們還可以通過自定義樣式的方式滿足課題方提出的要求，減少花費在布局、排版上的時間。
最后可以通過導出 PDF（文件 -> 導出 -> PDF）的功能，生成便于傳播與發(fā)布的文檔。
2025 imooc.com All Rights Reserved |