# DoxygenInsert

**Repository Path**: william19941994/doxygen-insert

## Basic Information

- **Project Name**: DoxygenInsert
- **Description**: 往keil的c文件中自动插入doxygen格式的注释
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2023-03-11
- **Last Updated**: 2024-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DoxygenInsert

#### 介绍
往keil的c文件中自动插入doxygen格式的注释

#### 软件架构
使用vs2019社区版 + winform + .net framework 4.0开发。
没有使用任何第三方库。
里面做了个及其简单的c语言词法分析器。并基于它解析出来了函数列表。 


#### 安装教程

0.  必须先安装.net framework 4.0 或者4.8 ==> [https://dotnet.microsoft.com/zh-cn/download/dotnet-framework/net40](https://dotnet.microsoft.com/zh-cn/download/dotnet-framework/net40)
1.  打开Keil
2.  Tools菜单的Customize Tool Menu
3.  新建（叉号左边的那个按钮）
4.  Command选择本项目bin目录中的exe
5.  Arguments 输入 -Proj #P -File #F -Line ~F -Pos ^F -Keil #X -CPU $M
6.  保存
7.  Keil中打开项目，打开一个文件，然后点Tools菜单的刚刚新建的子菜单。

#### 使用说明

1.  Keil中打开项目
2.  打开一个文件
3.  然后点Tools菜单的刚刚新建的子菜单。
![输入图片说明](HowToUse.png)

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request
欢迎大家交流，哪怕是提交issue也是对开源的大力支持。


#### 特技

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