Markdown 綜合實(shí)例

1. 前言

本節(jié)我們綜合運(yùn)用前面章節(jié)的內(nèi)容，完成一篇具有格式的論文。

論文以《XX 管理系統(tǒng)設(shè)計(jì)與實(shí)現(xiàn)》作為題目，包含畢業(yè)論文所需的主要對(duì)象，如標(biāo)題、段落、設(shè)計(jì)圖、表格、引用等。只為體現(xiàn)格式與排版效果，內(nèi)容純屬虛構(gòu)。

2. 語(yǔ)法詳解

2.1 文章結(jié)構(gòu)規(guī)劃

一篇完整的論文需要包含封面、摘要、目錄、正文（緒論、需求分析、概要設(shè)計(jì)、功能實(shí)現(xiàn)、系統(tǒng)測(cè)試）、結(jié)束語(yǔ)、致謝、參考文獻(xiàn)。我們用一級(jí)標(biāo)題表示以上內(nèi)容。方式如下：

實(shí)例 1：

用一級(jí)標(biāo)題劃分文章結(jié)構(gòu)，并用注釋簡(jiǎn)述該部分的核心內(nèi)容。

<!-- 封面 -->

# 摘要

<!-- 中文和英文摘要，包含關(guān)鍵詞 -->

# 目錄

<!-- 使用 [TOC] 生成目錄 -->

# 第一章 緒論

<!-- 描述寫(xiě)作目的，以文字為主，引用他人數(shù)據(jù) -->

# 第二章 需求分析

<!-- 包含餅圖 -->

# 第三章 概要設(shè)計(jì)

<!-- 包含流程圖、類(lèi)圖、數(shù)據(jù)庫(kù)表等 -->

# 第四章 功能實(shí)現(xiàn)

<!-- 穿插大量的圖片和源代碼 -->

# 第五章 系統(tǒng)測(cè)試

<!-- 以表格為主 -->

# 結(jié)束語(yǔ)

<!-- 純文字部分 -->

# 致謝

<!-- 純文字部分 -->

# 參考文獻(xiàn)

<!-- 尾注 -->

其渲染效果如下：

2.2 摘要部分

摘要部分通常為一大段普通文字加關(guān)鍵詞，其中「關(guān)鍵詞」三個(gè)字要加粗強(qiáng)調(diào)顯示。

實(shí)例 2：

摘要的實(shí)例。

# 摘要

這里插入任意的文本內(nèi)容。

...

這里插入任意的文本內(nèi)容。

**關(guān)鍵詞**：編輯器，格式化，Markdown。

其渲染效果如下：

2.3 緒論部分

緒論部分已文字為主，適當(dāng)增加引用。

實(shí)例 3：

緒論部分的實(shí)例。

# 第一章 緒論

## 1.1 課題背景

[這是一段正文內(nèi)容]

>引用他人的論點(diǎn)論據(jù)，用來(lái)佐證本文的背景及意義。
>
>——引文出處，適當(dāng)增加尾注[^1]

[這是一段正文內(nèi)容]

## 1.2 信息化管理

## 1.3 系統(tǒng)設(shè)計(jì)目的和內(nèi)容

[^1]: 緒論尾注 1 的內(nèi)容。

其渲染效果如下：

2.4 需求分析

需求分析一般包含可行性分析、業(yè)務(wù)需求、數(shù)據(jù)項(xiàng)分析。

實(shí)例 4：

需求分析實(shí)例。

# 第二章 需求分析

## 2.1 可行性分析

### 2.1.1 技術(shù)可行性

同類(lèi)產(chǎn)品技術(shù)解決方案：

- XX 公司實(shí)現(xiàn)的產(chǎn)品，用了 XX 技術(shù)；
- XX 公司實(shí)現(xiàn)的產(chǎn)品，用了 XX 技術(shù)；
- XX 公司實(shí)現(xiàn)的產(chǎn)品，用了 XX 技術(shù)。

### 2.1.2 經(jīng)濟(jì)可行性

?```mermaid
pie title 市場(chǎng)分析
    "已改造" : 386
    "未改造" : 85
?```

<center>圖1：市場(chǎng)分析圖</center>

### 2.1.3 管理可行性

## 2.2 需求分析

### 2.2.1 功能需求

- 功能點(diǎn)1
  - 子功能點(diǎn) 1-1
  - 子功能點(diǎn) 1-2
  - 子功能點(diǎn) 1-3
- 功能點(diǎn)2
  - 子功能點(diǎn) 2-1
  - 子功能點(diǎn) 2-2
- 功能點(diǎn)3

### 2.2.2 環(huán)境需求

| 需求項(xiàng)   | 需求指標(biāo)  |
| -------- | --------- |
| 操作系統(tǒng) | CentOS 7  |
| 數(shù)據(jù)庫(kù)   | Mysql 5.7 |
| 內(nèi)存     | 8G        |
| 硬盤(pán)     | 100G      |

## 2.3 數(shù)據(jù)項(xiàng)分析

數(shù)據(jù)表整理

| 數(shù)據(jù)對(duì)象 | 簡(jiǎn)述               | 來(lái)源     | 核心數(shù)據(jù)項(xiàng)   | 主鍵   |
| -------- | ------------------ | -------- | ------------ | ------ |
| 管理員表 | 保存系統(tǒng)管理員信息 | 注冊(cè)     | 登錄名       | 登錄名 |
| 學(xué)生表   | 保存學(xué)員信息       | 批量導(dǎo)入 | 姓名、學(xué)號(hào)   | 學(xué)號(hào)   |
| 老師表   | 保存教職工信息     | 批量導(dǎo)入 | 姓名、職工號(hào) | 職工號(hào) |
| 部門(mén)表   | 保存部門(mén)、班級(jí)信息 | 批量導(dǎo)入 | 名稱(chēng)、編號(hào)   | 編號(hào)   |

其渲染效果如下：

2.5 概要設(shè)計(jì)

設(shè)計(jì)部分以圖表形式的內(nèi)容最多。

實(shí)例 5：

# 第三章 概要設(shè)計(jì)

## 3.1 數(shù)據(jù)表設(shè)計(jì)

**管理員表**

管理員表的描述文字。

*表1：管理員表結(jié)構(gòu)*

| 列名     | 數(shù)據(jù)類(lèi)型    | 長(zhǎng)度 | 非空 | 主鍵 |
| -------- | ----------- | ---- | ---- | ---- |
| id       | UUID        | 64   | √    | √    |
| account     | VARCHAR(32) | 32   | √    |      |
| password | VARCHAR(32) | 32   |      |      |

**學(xué)生信息表**

學(xué)生信息表的描述文字。

*表2：管理員表結(jié)構(gòu)*

| 列名     | 數(shù)據(jù)類(lèi)型    | 長(zhǎng)度 | 非空 | 主鍵 |
| -------- | ----------- | ---- | ---- | ---- |
| id       | UUID        | 64   | √    | √    |
| name     | VARCHAR(32) | 32   | √    |      |
| age | Integer | 8   |      |      |

## 3.2 數(shù)據(jù)表關(guān)系圖

?```mermaid
classDiagram
	學(xué)員表 --> 部門(mén)表 : 關(guān)聯(lián)
	職工表	--> 部門(mén)表 : 關(guān)聯(lián)
	class 學(xué)員表 {
    id
    部門(mén) ID <fk>
	}
	class 職工表 {
    id
    部門(mén) ID <fk>
	}
	class 部門(mén)表 {
    id
	}
?```

<center>圖3-1：數(shù)據(jù)關(guān)系表</center>

## 3.3 功能結(jié)構(gòu)圖

?```mermaid
graph LR
	XX管理系統(tǒng) --> 管理員登錄
	管理員登錄 --> 系統(tǒng)設(shè)置
	管理員登錄 --> 學(xué)員管理
  管理員登錄 --> 教師管理
 	管理員登錄 --> 部門(mén)管理
 	部門(mén)管理 --> 增加
 	部門(mén)管理 --> 修改
 	部門(mén)管理 --> 刪除
 	部門(mén)管理 --> 批量導(dǎo)入
?```

<center>圖3-2：功能結(jié)構(gòu)圖</center>

其渲染效果如下：

2.6 功能實(shí)現(xiàn)

系統(tǒng)功能實(shí)現(xiàn)部分多以代碼和截圖為主。

# 第四章 功能實(shí)現(xiàn)

## 4.1 后臺(tái)代碼實(shí)現(xiàn)

?```java
public class Starter {
	public static void main(String[] args) {
  	System.out.println("Hello world");
  }
}
?```

## 4.2 前端代碼實(shí)現(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 類(lèi)型的配置文件：

?```properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/helloworld?characterEncoding=utf8
jdbc.username=root
jdbc.password=root
?```

## 4.4 運(yùn)行及啟動(dòng)日志

?```bash
java Starter
---
Hello world
?```

網(wǎng)頁(yè)截圖：

![](../images/4-1.png)

<center>圖4-1：訪問(wèn)效果圖</center>

其渲染效果如下：

2.7 系統(tǒng)測(cè)試

系統(tǒng)測(cè)試部分多以列表及表格為主。

實(shí)例 7：

# 第五章 系統(tǒng)測(cè)試

## 5.1 功能點(diǎn)完成情況對(duì)照

- [x] 數(shù)據(jù)庫(kù)創(chuàng)建
- [x] 后端開(kāi)發(fā)
- [x] 前端開(kāi)發(fā)
- [x] 接口聯(lián)調(diào)
- [ ] 日志歸檔

## 5.2 測(cè)試結(jié)果

| 功能點(diǎn)       | 是否測(cè)試                     | 是否通過(guò)                     | 備注 |
| ------------ | ---------------------------- | ---------------------------- | ---- |
| 登錄         | <font color="green">√</font> | <font color="green">√</font> | 無(wú)   |
| 登出         | <font color="green">√</font> | <font color="red">×</font>   | 無(wú)   |
| 增加學(xué)員信息 | <font color="red">×</font>   | <font color="red">×</font>   | 無(wú)   |

其渲染效果如下：

2.8 參考文獻(xiàn)

參考文獻(xiàn)部分是尾注的匯總。

正文某處[^1]

正文某處[^2]

正文某處[^3]

# 參考 文獻(xiàn)

[^1]: XXX，圖書(shū)管理系統(tǒng)設(shè)計(jì)。北京：北京大學(xué)出版社，2008。
[^2]: XXX，師生管理系統(tǒng)設(shè)計(jì)。北京：清華大學(xué)出版社，2009。
[^3]: XXX，軟件工程（三）。北京：郵電大學(xué)出版社，2019。

其渲染效果如下：

2.9 為論文增加目錄

在論文的目錄章節(jié)后面插入 [TOC]

# 目錄

[TOC]

其渲染效果如下：

3. 小結(jié)

本節(jié)內(nèi)容綜合運(yùn)用了前述的各個(gè)小節(jié)的知識(shí)點(diǎn)。

實(shí)際應(yīng)用中，我們還可以通過(guò)自定義樣式的方式滿(mǎn)足課題方提出的要求，減少花費(fèi)在布局、排版上的時(shí)間。

最后可以通過(guò)導(dǎo)出 PDF（文件 -> 導(dǎo)出 -> PDF）的功能，生成便于傳播與發(fā)布的文檔。