代码规范 注释规范 效率工具

                                               __   _                  __   _                                        
__      __ __      __ __      __       ___    / _| (_)  _ __    ___   / _| | |  _   _        ___    ___    _ __ ___  
\ \ /\ / / \ \ /\ / / \ \ /\ / /      / _ \  | |_  | | | '__|  / _ \ | |_  | | | | | |      / __|  / _ \  | '_ ` _ \ 
 \ V  V /   \ V  V /   \ V  V /   _  | (_) | |  _| | | | |    |  __/ |  _| | | | |_| |  _  | (__  | (_) | | | | | | |
  \_/\_/     \_/\_/     \_/\_/   (_)  \___/  |_|   |_| |_|     \___| |_|   |_|  \__, | (_)  \___|  \___/  |_| |_| |_|
                                                                                |___/                                

代码编写风格

• 华为代码编程规范

代码质量检查

• 华为云 代码检查​

代码文档生成

• 使用Doxygen生成动态文档
• 使用Graphviz分析逻辑过程

代码注释风格

• 注释模板

• 参考STM32官方库，帮助文件使用Doxygen生成

工具：Doxygen 官网：http://www.doxygen.nl

功能介绍：

​ Doxygen 是一个程序的文件产生工具，可将程序中的特定注释转换成为说明文件。通常我们在写程序时，或多或少都会写上注释，但是对于其它人而言，要直接探索程序里的注释，与打捞泰坦尼克号同样的辛苦。大部分有用的注释都是属于针对函数、类型等等的说明。所以，如果能依据程序本身的结构，将注释经过处理重新整理成为一个纯粹的参考手册，对于后面利用您的程序代码的人而言将会减少许多的负担。不过，反过来说，整理文件的工作对于您来说，就是沉重的负担。

​ 对于未归档的源文件，也可以通过配置Doxygen来提取代码结构。或者借助自动生成的包含依赖图（includedependency graphs）、继承图（inheritance diagram）以及协作图（collaborationdiagram）来可视化文档之间的关系。Doxygen生成的帮助文档的格式可以是CHM、RTF、PostScript、PDF、HTML和Unixman page等。

​ 一个好的程序设计师，在写程序时，都会在适当的地方加上合适的注释。如果，能够在撰写注释时，稍微符合某种格式，接着就可以透过一个工具程序依据程序结构及您的批注产生出漂亮的文件。这将令许多工作繁重的程序设计师有时间多喝几杯咖啡。

​ Doxygen 就是这样的一个工具。在您写批注时，稍微按照一些它所制订的规则。接着，他就可以帮您产生出漂亮的文件了。因此，Doxygen 的使用可分为两大部分。首先是特定格式的批注撰写，第二便是利用Doxygen的工具来产生文件。

工具：Graphviz 官网：http://www.graphviz.org/

功能介绍：

​ Graphviz可以生成视图连接将.c文件中所用到的函数、头文件生成一个树状结构并且设置之后可以生成相对应的函数的跳转，方便查询函数。

代码注释规范

---

一，全局变量、宏定义、类型定义的注释

/** 简要说明文字 */
变量（宏定义 或 类型定义）

---

二，结构体类型、枚举体类型的注释

/** 简要说明文字 */
typedef 类型 结构体名字
{
	成员1,	/**< 简要说明文字 */
	成员2,	/**< 简要说明文字 */
	成员3,	/**< 简要说明文字 */
}

---

三，函数头注释

/**
  *-----------------------------------------------------------------------------
  * @brief		函数功能、性能等的描述
  * @param		参数名	参数说明
  * @return		返回值
  *-----------------------------------------------------------------------------
  */

---

四，文件头注释

/**
  ******************************************************************************
  * @copyright	版权说明
  * @file		文件名
  * @brief		文件功能简述
  * @version	版本号
  * @author		作者
  * @date		创建日期
  ******************************************************************************
  * @history	修改历史
  ******************************************************************************
  */