STM32CUBEIDE使用函数注释功能

在STM32CUBEIDE中自动生成函数注释的方法

  • 其实在STM32CUBEIDE中是集合了函数注释插件 Doxygen的 但是STM32CUBEIDE默认是不开启这个插件的。
  • 开启方法如下:
    1、打开工程 选择 Project选项卡下的Propertites
    Project ->Properties
    2.在C/C++ General 中右侧选项卡开启 Enable project specific settings,
    选择Documentation tool:为Doxygen
    Documentation中选择Doxygen
    3、使用方法
    在要插入注释的函数上方 输入/** 后回车,软件自动进行函数注释

STM32CUBEIDE中使用doxygen


最后 再补充注释内容

在这里插入图片描述

### 解决 STM32CubeIDE注释显示为乱码的方法 在开发过程中遇到的编码问题通常与字符集设置有关。当使用非英文字符时,特别是中文字符,在不同环境中可能因为默认编码不一致而出现问题。 对于 STM32CubeIDE注释显示为乱码的情况,可以尝试调整项目属性中的文本文件编码选项来解决问题[^2]。具体操作是在 IDE 内部找到项目的 Properties 设置页面,导航到 Resource 部分下的 Text file encoding 子项。这里建议将编码方式更改为 UTF-8 或 GBK;尽管选择这两种编码之一并不能完全消除所有情况下的乱码现象——例如选用 UTF-8 可能会在某些情况下引起串口打印中文时出现乱码,但是这一步骤有助于改善源代码编辑器内的注释显示效果。 另外值得注意的是,除了修改上述提到的编码参数之外,还需要确认所使用的字体能够正确渲染所需的字符。如果当前使用的字体缺少对特定语言的支持,则即使解决了编码问题也可能继续看到乱码。因此可以在 Preferences -> General -> Appearance 下更改 Editor 字体至支持更多国际字符集的样式,比如 Consolas, Arial Unicode MS 等通用型字体。 最后,确保所有的工具链组件都统一采用相同的字符编码标准也很重要。这意味着不仅要在 IDE 层面做出相应调整,还要检查编译链接过程以及最终生成的目标平台是否也遵循同样的编码规则。 ```cpp // 示例:C/C++ 文件头部声明编码格式 #pragma once #ifdef __cplusplus extern "C" { #endif // 编写多字节字符串常量前加上 u8 前缀以指示其为 UTF-8 编码 const char* str = u8"你好世界"; #ifdef __cplusplus } #endif ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值