开发文档生成规范,快速生成开发文档,自动放到docs目录下,方便技术快速了解项目,能快速入手开发
dev-docs/ 目录时触发dev-docs/phpapi/ 目录时触发dev-docs/admin/ 目录时触发dev-docs/uniapp/ 目录时触发dev-docs/nuxt/ 目录时触发文档、说明、指南、手册、规范API、接口、部署、开发、需求.md (Markdown 文件).txt (文本文件).doc/.docx (Word 文档).pdf (PDF 文档)api接口文档.md、部署指南.md# 表示标题层级- 或 1. 表示**加粗** 或 *斜体*// 获取用户信息
public function getUserInfo($id) {
return $this->where('id', $id)->find();
}
dev-docs 目录中dev-docs/phpapi 目录中dev-docs/admin 目录中dev-docs/uniapp 目录中dev-docs/nuxt 目录中# 文档标题
## 1. 引言
### 1.1 文档目的
- 说明文档的编写目的
### 1.2 适用范围
- 说明文档的适用范围
### 1.3 术语定义
- 解释文档中使用的专业术语
## 2. 主体内容
### 2.1 功能描述
- 详细描述功能特性
### 2.2 实现方案
- 说明技术实现方案
### 2.3 代码示例
```php
// 代码示例
function example() {
return true;
}
版本: 1.0 作者: 文档作者 更新日期: YYYY-MM-DD
## 7. Markdown 语法指南
### 7.1 标题
```markdown
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
// JavaScript 代码
console.log('Hello World');
| 表头 1 | 表头 2 |
|---|---|
| 单元格 1 | 单元格 2 |
| 单元格 3 | 单元格 4 |
这是一段引用文本
以上规范适用于 CRMEB 项目所有文档写作,确保文档质量和一致性。