正点原子Linux团队C代码规范化指南

嵌入式Linux C代码规范化是由正点原子团队编写的文档，旨在为初级和中级嵌入式工程师提供一套代码规范和风格指南。该文档源于作者左忠凯在从STM32单片机开发转向Linux C开发的过程中，针对遗留的编码习惯进行的系统整理，强调了代码风格的个体差异和个人原则，但也提出了明确的编码标准。 文档共分为五个章节： 1. 规范说明：明确写作动机，旨在改进作者自身的代码质量，以及帮助开发者避免陋习，提升代码可读性和一致性。 2. 排版格式和注释：包括代码缩进（使用统一的空格而不是制表符）、代码行长度、括号和空格的使用规则，以及注释的风格和用途，如文件信息注释、函数注释等。 3. 标识符命名：提出清晰的命名规则，涉及文件名、变量名、函数名和宏名的选择，强调一致性，减少歧义。 4. 函数：详细规定函数的定义和调用格式，注重可维护性和可理解性。 5. 变量和宏及常量：对变量的生命周期管理，以及宏和常量的使用规范进行阐述。 参考文献包括Linux源码的CodingStyle文档，《代码整洁之道》、GNU编码规范和华为的C语言编程规范，强调文档的参考性质而非强制执行。文档作者认识到，虽然个人编码风格各异，但良好的代码规范有助于团队协作和代码的长期维护。 在阅读和使用这份规范时，读者应理解其目的不是强制所有开发者接受，而是作为提升代码质量和团队协作效率的一种工具，以期在多数情况下达成一致。正点原子团队鼓励开发者根据自身习惯和项目需求灵活应用这些规则，确保代码既符合规范，又能体现个人的专业素养。