添加 'Home'

Myth 2021-10-11 17:33:57 +08:00
commit cb599c0660

51
Home.md Normal file

@ -0,0 +1,51 @@
# Home
### 工程模版
[bc0a2d2034](https://hub.akashic.cc/GML-Group/MasterNode/src/commit/bc0a2d20344a19c2efd62c7c2b2a3636fe81af35) 为工程模版。
工程模版实现了系统的基本初始化、Systick 定时器以及串口 FIFO。主节点和子节点都可以在这个工程模版上进行。
工程模版的功能为:向 USART1 发送内容会通过接收中断实现回显。波特率为 115200。回显的同时 PC13 上的 LED 会闪烁。
### 工程文件
工程文件均采用 UTF-8 编码格式。不可使用 GBK 或 GB2312。
代码中字符串不可出现中文,更不可向串口输出中文字符串。但注释可采用中文。
### 编码规范
下面是一些基本的编码规范:
+ 宏定义采用全大写 + 下划线。例如 LED_PIN
+ 变量采用全小写 + 下划线。例如 user_name
+ 函数名采用大驼峰 + 下划线。例如 UART_Send
+ 结构体名称采用大驼峰、无下划线。例如 BookData
+ 大括号一律换行、对齐。
+ 如果 if 和 else 后的内容均只有一行或只有 if 且只有一行,可以省略大括号。否则禁止省略
### 注释风格
行注释使用 // 即可。// 后可不空格,但 // 与 ; 间至少空一格。例如:
HAL_GPIO_Init(GPIOC, &GPIO_Initure); //初始化 PC13
函数注释采用 Doxygen 注释风格。
以下是一个典型的函数注释:
/**
* @brief 从接收缓冲区读取到特定字节,阻塞,有超时
* @param _ucPort: 端口号 (COM1-2)
* @param _pBuf: 接收到的数据指针
* @param _endByte: 终止字节
* @param _timeout: 超时时间
* @retval 0 表示超时1 表示成功
*/
uint8_t UART_GetBuffUntil(COM_PORT_E _ucPort, uint8_t *_pBuf, uint8_t _endByte, uint16_t _timeout)
{
//...
}
当函数无参时,可省略 @param;当函数无返回值时,可省略 @retval