yiranxijie/Source_Insight_Macro_DoxygenFormat

Source Insight快捷宏，基于quicker.em进行修改，最终目的在于，采用便捷的方式添加注释，并符合Doexgen的解析规则

• Source-Insight-Macro
• 一、简介
  • 1.自定义组织信息
  • 2.Doxygen风格的函数注释以及Todo标签
  • 3.Doxygen格式的单行注释风格
• 二、FAQ
  • 1.关于SourceInsight版本问题
  • 2.关于Doexgen使用问题
• 三、参考与链接

Source-Insight-Macro

一、简介

  该仓库旨在为 C/C++ 的开发人员提供一套符合 Doxygen 注释风格的SourceInsight 宏。具体的宏实现基于 quicker.em 。   该仓库的具体工作主要是在原有 quicker.em 的基础上，根据 Source Insight 宏语言 语法要求，对其原有功能的扩展，新增功能见下文。

1. 自定义组织信息

  允许用户在通过 config 进行初始配置的过程中，输入自定义的组织名称。倘若输入为空，则默认为 XXX 。

2. Doxygen风格的函数注释以及Todo标签

  按照Doxygen注释风格的要求，修改 quicker.em 原有的注释风格。同时添加 todo 、note 、bug 三种标签，用以丰富注释语言。

3. Doxygen格式的单行注释风格

  改功能按照 Doxygen 注释风格的要求，为代码添加单行注释，需要为该宏——DoxygenComment设置专用的快捷键，本人一般将其绑定为 Alt + D 。

二、FAQ

1.关于SourceInsight版本问题

  本人在测试与开发过程中，主要基于 Sourceinsight 4.00.0087,在之前版本上测试时，发现部分宏无法识别；尚未在最新软件上进行测试。

2.关于Doexgen使用问题

  关于Doxygen的使用方法，可以参见此博客。

三、参考与链接

1. quicker.em:https://wenku.baidu.com/view/417e4b34eefdc8d376ee3259.html

2. Doxygen:https://baike.baidu.com/item/Doxygen/1366536?fr=aladdin

3. Source Insight 宏语言:https://www.sourceinsight.com/doc/v4/userguide/index.html#t=Manual%2FMacro_Language%2FMacro_Language.htm

4. Doxygen注释风格:https://my.oschina.net/zhfish/blog/35422

5. Doxygen的使用方法，可以参见此博客:https://blog.csdn.net/chenyujing1234/article/details/19115319