# comments

**Repository Path**: Ging_H/comments

## Basic Information

- **Project Name**: comments
- **Description**: 在函数前面添加注释
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-06
- **Last Updated**: 2024-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# comments

#### 介绍
在函数前面添加注释,主要在Keil中使用外部工具,给当前的函数添加注释


#### 软件架构
Qt5.9.0 
mingw-32bit 5.3
C++


#### 使用说明
```bash
Usage: comments [options] file
Add comments for function/file

Options:
  -?, -h, --help  Displays this help.
  -v, --version   Displays version information.
  -t <type>       注释类型,function or src or header
  -r <row>        函数定义所在行(从0开始递增)
  -p <template>   注释模板文件

Arguments:
  file            the file to open

```

* 光标可以放置在函数所在行及前面的空行处,光标到函数所在行之间务必保持干净
* 必须先保存当前改动,否则无法准确识别添加注释

![输入图片说明](https://foruda.gitee.com/images/1733447185922374913/8d09c1b0_5181115.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1733447521982314570/f9f0e815_5181115.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1733447202636715140/b95a0edd_5181115.png "屏幕截图")
![输入图片说明](https://foruda.gitee.com/images/1733447212349209559/f7070618_5181115.png "屏幕截图")

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request