命名规范-Read.doc

Porsche9平台编程规范（V0.9） 为了便于统一开发，经讨论制定了Porsche9平台编程的一般规范，请大家按照这个开展编码工作，在进行代码和软件评审时，以本规范为依据。 1、注释 文件注释应包含：版权信息，文件名称，摘要，作者，完成日期，历史信息等等 模板及实例： /******************************************************/ Copyright(C)2007,Rockchip Co., Ltd. All Rights Reserved. File:alcalend.c Desc:完成阴阳历转换及月历功能. Note: Author:Robert $Log: alcalend.c,v $ Revision 1.2 2007/01/09 Robert 增加月历 /******************************************************/ 模块注释说明：模块注释在每个模块的开头 ，这里的模块可能是一个函数之类的代码。 模板及实例: /******************************************************/ Name: JudgeIfSolarLeap Desc: 判断输入的阳历年份是否闰年 Param: UINT16 year---输入的阳历年份 Return:TRUE---是闰年,FALSE---非闰年 Global:无 Note: 注意输入年份的范围是[1900-2000] Author:Robert Log: /******************************************************/ 代码注释： ▼ 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。 ▼ 关键的地方和复杂的地方应当添加注释，如果代码本来就是清楚的，不必加注释。 ▼ 保证注释与代码的一致性。不再有用的注释要删除。 2、函数、变量、文件的命名 一般性原则：各种命名力求使人一看就懂，保持一个文件中命名风格的统一性，以求达到保持本模块命名的统一性，最终达到整个软件平台风格的统一性。 ▼ 函数的命名遵循PASCAL命名法，其原则是：对对构成函数名称的每个单词的首字母大写。 实例：设置code音量 CodecSetVolume(int vol) ▼ 变量的命名结合PASCAL命名法和匈牙利，其原则是：对对构成变量名称的每个单词的首字母大写，全局变量加前缀g，指针变量加前缀p 实例： 指向FM音量的指针变量 pFmVolume 防止局部变量与全局变量同名，代码阅读时容易引起混乱，所以，请避免 ▼ 文件的命名尽量保持在8个字母以内，以模块的缩写开头， 实例： FM的界面部分代码：FmUI.c FM的驱动部分代码：FmDrv.c 3、函数 ▼ 在函数体的“入口处”，对输入的参数的有效性进行检查，在函数体的“出口处”，对return语句的正确性和效率进行检查 ▼ 为提高ARM系统效率，函数带入的参数尽量控制在4个以内 ▼ 为保证多任务时函数的可重入性，函数内尽量不直接访问全局 ▼ 函数的功能要单一，不要设计多用途的函数，一个函数做好一件事情 ▼ 函数的规模尽量限制在200行以内 说明：设计高扇入、合理扇出（小于7）的函数。说明：扇出是指一个函数直接调用（控制）其它函数的数目，而扇入是指有多少上级函数调用它。扇出过大，表明函数过分复杂，需要控制和协调过多的下级函数；而扇出过小，如总是1，表明函数的调用层次可能过多，这样不利程序阅读和函数结构的分析，并且程序运行时会对系统资源如堆栈空间等造成压力。函数较合理的扇出（调度函数除外）通常是3-5。扇出太大，一般是由于缺乏中间层次，可适当增加中间层次的函数。扇出太小，可把下级函数进一步分解多个函数，或合并到上级函数中。当然分解或合并函数时，不能改变要实现的功能，也不能违背函数间的独立性。扇入越大，表明使用此函数的上级函数越多，这样的函数使用效率高，但不能违背函数间的独立性而单纯地追求高扇入。公共模块中的函数及底层函数应该有较高的扇入。较良好的软件结构通常是顶层函数的扇出较高，中层函数的扇出较少，而底层函数则扇入到公共模块中。 4、H文件的要求 ▼ 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块。 ▼ 头文件中只存放“声明”而不存放“实现” ▼ 头文件单向(向下或平向)包含，防止本模块头文件中包含其上层调用者的头文件，应防止交叉包含等等。 5、指针和内存 ▼ 定义指针变量的同时一定初始化该指针变量 ▼ 用ma