# JsonCommentTool

**Repository Path**: redchairman/JsonCommentTool

## Basic Information

- **Project Name**: JsonCommentTool
- **Description**: 基于Json文本自动生成markdown格式的字段说明文档（表格）
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2020-04-11
- **Last Updated**: 2022-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# JsonCommentTool

#### 介绍
基于Json文本自动生成markdown格式的字段说明文档（表格）

#### 使用说明

1.  Windows下使用Bin目录下文件可以直接运行
2.  其他操作系统需要自行编译
3.  程序基于qt5.5.0开发

#### 效果演示

输入json为：
{
  "error_code" : "",
  "error_msg" : ""
}

输出:
| 字段 | 类型 | 必选 | 说明 |
| ---- | ---- | ---- | ---- |
| error_code | string | 是 |  |
| error_msg | string | 否 |  |

当然在输出markdown前，可通过工具对文档进行编辑，例如编辑字段类型和说明文字

#### 码云特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)