【ARM调试笔记】简化版的命名规则

博主分享了自己在编程中遇到的变量命名问题,主要使用unsigned char和unsigned long变量,发现传统匈牙利命名法影响了代码的可读性。于是提出了一个简化版的命名规范,通过大驼峰和小驼峰来区分全局和局部变量,以提高代码的直观性和易读性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

前一版的主要是基于匈牙利命名法混合了大驼峰和小驼峰,在实际感受时发现自己基本用的都是unsigned char变量和unsigned long变量,这些变量占了我所用的变量的90%,全部替换后,发现读起来反而影响了我的程序的阅读性。

于是自己琢磨了一个直观易读的简化版本。省略掉前缀而采用大驼峰小驼峰来区别全局变量和局部变量(静态变量视作全局变量处理),此版本更加符合我的命名习惯。

 

<think>嗯,用户现在问的是关于嵌入式学习文件夹的文件命名方法。首先,我需要理解用户的具体需求。嵌入式学习可能涉及多个方面,比如编程、硬件设计、项目文档等,所以合理的文件命名对于组织这些内容非常重要。用户可能是刚开始学习嵌入式系统,或者在整理已有资料时遇到了困难,想要一个系统化的命名方式,方便以后查找管理。 接下来,我需要考虑用户可能的背景。可能是一个学生、自学者,或者刚进入嵌入式领域的工程师。他们可能对文件管理的最佳实践不太熟悉,所以需要简单明了但有效的建议。同时,用户可能希望命名规则既能分类清晰,又具备一定的灵活性,以适应不同阶段或不同类型的项目。 然后,我需要分析嵌入式学习的常见内容。通常包括代码、电路图、文档、参考资料、项目案例等。每种类型的文件可能有不同的命名需求。例如,代码文件可能需要包含本信息,而项目文档可能需要日期或模块名称。 用户可能没有明确提到的深层需求是希望提高学习效率,通过良好的文件管理减少查找时间,避免重复或混乱。因此,命名规则不仅要清晰,还要有一定的扩展性,方便后续添加新内容。 接下来,我需要考虑常见的文件命名方法,比如按功能、日期、项目名称、本号等分类。同时,可能需要结合嵌入式学习的特点,比如硬件模块、开发板型号、编程语言等。还要注意命名的一致性可读性,避免使用含糊不清的缩写。 另外,用户可能需要在不同操作系统或工具中共享文件,所以命名规则应兼容不同的文件系统限制,比如避免特殊字符,控制文件名长度等。此外,本控制也是一个重要方面,特别是当用户进行项目迭代时,如何管理不同本的文件。 可能的误区是用户可能会过度复杂化命名规则,导致难以坚持使用。因此,建议的规则需要简洁实用,同时给出示例帮助用户理解。比如,可以按类别-项目-日期-本的格式,或者使用层次化的文件夹结构来辅助命名。 最后,需要总结出具体的命名规则,并给出实际案例,让用户能够直接应用。同时提醒一些注意事项,如避免空格、统一日期格式等,确保命名的一致性有效性。</think>在嵌入式学习过程中,清晰的文件命名文件夹结构能显著提升学习效率项目管理能力。以下是一些建议的命名规则分类方法,结合功能、项目、时间等维度: --- ### **一、文件夹结构示例** 建议按模块项目分层管理,例如: ``` 嵌入式学习/ ├── 1_基础知识/ │ ├── C语言/ │ │ ├── 01_基础语法(变量、指针) │ │ ├── 02_数据结构(链表、队列) │ ├── 电子电路基础/ │ │ ├── 电路分析笔记 │ │ ├── 常用元件手册 │ ├── 2_开发环境/ │ ├── Keil_ARM/ │ ├── STM32CubeMX配置案例 │ ├── VSCode嵌入式配置 │ ├── 3_实战项目/ │ ├── Project1_智能温控系统/ │ │ ├── 硬件设计(原理图、PCB) │ │ ├── 固件代码(V1.0、V1.1) │ │ ├── 测试报告_20231001 │ ├── Project2_蓝牙遥控小车 │ ├── 4_参考资料/ │ ├── STM32F4xx官方手册 │ ├── FreeRTOS开发指南 │ └── 5_工具与驱动/ ├── JLink驱动 ├── 串口调试工具 ``` --- ### **二、文件命名规则** 1. **核心原则** - **清晰明确**:通过文件名快速判断内容(如功能、本、日期)。 - **一致性**:全文件夹统一命名风格,避免混用“V1”“Ver1.0”。 - **可排序**:用数字前缀(如`01_`、`02_`)或日期(如`20231001`)保证顺序。 2. **推荐格式** - **通用模板**:`类别_项目名_日期_本.扩展名` - 例:`代码_智能温控_20231001_V1.2.zip` - **简化模板**:`功能描述+本/日期` - 例:`按键驱动_V2.1.c`、`PCB布局_最终.pdf` 3. **分场景命名** - **代码文件**:`功能_芯片型号_本` - 例:`PWM控制_STM32F407_V1.0.c` - **硬件设计**:`模块名_设计阶段_本` - 例:`电源电路_原理图_V2.0.sch` - **文档报告**:`项目名_内容_日期` - 例:`智能家居_测试报告_20231001.docx` - **工具/配置**:`工具名_本_平台` - 例:`STM32CubeIDE_V1.10_Windows.zip` --- ### **三、注意事项** 1. **避免冗余** - 删除临时文件(如`test1.c`、`final_final.c`),用本号替代。 2. **兼容性** - 避免特殊字符(`/\:*?"<>|`),用下划线`_`或短横线`-`代替空格。 3. **日期格式** - 统一用`YYYYMMDD`(如`20231001`),便于排序检索。 4. **本管理** - 推荐语义化本号(如`V1.2.1`),或用日期标记(`Beta_20231001`)。 --- ### **四、高级技巧** 1. **自动化工具** - 使用脚本批量重命名(如Python的`os.rename`)。 2. **本控制** - 用Git管理代码(如`git tag V1.0`),替代手动保存多个副本。 3. **README文件** - 在根目录项目文件夹中添加`README.md`,说明目录结构更新日志。 --- ### **五、示例对比** - **差**:`新建文件夹/project/new_code.c` - **优**:`实战项目/智能温控/固件代码_V1.3/温控算法_STM32F4.c` --- 通过合理的命名分类,可以快速定位文件,减少重复劳动,尤其适合嵌入式开发中频繁迭代跨模块协作的场景。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值