C语言软件编写规范
- 格式:docx
- 大小:14.73 KB
- 文档页数:8
C语言代码规范C语言是一种广泛应用于编程领域的高级编程语言,具有跨平台、效率高、灵活性强等优点。
编写规范合乎标准的C语言代码有助于提高代码的可读性、可维护性和可移植性。
本文将介绍一些常用的C语言代码规范,以帮助开发者编写高质量的C语言程序。
一、代码格式1. 缩进:使用四个空格进行缩进,不要使用制表符。
这样可以保证在不同编辑器或显示器上显示的代码缩进一致。
2. 行长度限制:每行代码应尽量保持在80个字符以内,超过限制的代码可以进行适当换行。
换行时要注意保持代码的清晰可读性,一般可以采用缩进来表达代码的层次关系。
3. 大括号:大括号的位置应该和相关语句对齐,且起始的大括号应该放在语句所在行的末尾,而不是单独另起一行。
4. 空格和空行:在适当的情况下使用空格和空行可以提高代码的可读性。
例如,在运算符和操作数之间使用空格,不同的代码块之间使用空行进行分割等。
二、命名规范1. 变量名:使用有意义的变量名,尽量避免使用单个字符或简单的缩写表示变量。
变量名应该忠实地反映其所代表的含义。
2. 函数名:函数名应使用动词和名词的组合,具体描述函数的功能。
函数名应该清晰地表达其所完成的操作或所返回的结果。
3. 常量名:常量名使用全大写字母,并使用下划线进行分隔。
例如,MAX_LENGTH。
4. 类型名:类型名使用首字母大写的驼峰命名法,例如,StudentInfo。
5. 宏定义名:宏定义名使用全大写字母,并使用下划线进行分隔。
例如,PI。
三、注释规范1. 单行注释:使用"//"进行单行注释,注释符号后面应该留一个空格。
注释应该清晰明了,解释代码的用途或特殊处理等。
2. 多行注释:使用"/*"和"*/"进行多行注释。
多行注释通常用于解释一整块代码的功能或原理等。
3. 函数注释:在每个函数定义的上方加上函数注释,注释中应该包含函数的功能描述、输入参数的说明、返回值的含义以及可能抛出的异常等信息。
c语言代码规范C语言是一种通用的编程语言,广泛应用于嵌入式系统、操作系统、驱动程序以及各种应用程序的开发中。
为了提高代码的可读性、可维护性和可移植性,制定一套严格的代码规范是非常必要的。
1. 缩进与空格:- 使用4个空格进行缩进,不要使用Tab键。
- 在运算符两侧以及逗号后加上一个空格。
2. 命名规范:- 变量、函数和类型的命名采用小驼峰命名法,例如myVariable。
- 全局变量以g_开头,静态变量以s_开头。
- 宏定义全部大写,并用下划线分隔单词。
3. 函数定义:- 函数名应该能够描述函数的功能。
- 函数名应该以动词开头,使用小驼峰命名法。
- 函数的参数列表应该明确指明参数的类型和名称。
4. 注释:- 在每个函数之前添加简要的注释,说明函数的功能、参数和返回值。
- 在复杂的代码块中添加必要的注释,解释代码的逻辑和目的。
5. 头文件:- 头文件应该包含必要的宏定义、类型定义和函数声明,不要包含具体的函数实现。
- 头文件应该有相应的宏定义来防止多次包含。
6. 文件结构:- 文件应该按照功能模块进行组织,每个功能模块放在一个独立的文件中。
- 文件中的代码应该按照逻辑顺序进行排列,函数之间使用空行进行分隔。
7. 魔法数值:- 不要直接在代码中出现魔法数值,应该使用常量或者宏来表示。
- 大多数情况下,常量应该在文件的头部定义,并加上相应的注释。
8. 错误处理:- 对于可能出现错误的函数调用,应该检查返回值并进行相应的错误处理。
- 错误处理可以是返回特定的错误码或者抛出异常,但应该保持一致。
9. 括号和空行:- 括号应该与控制语句在同一行,并在括号内留出空格。
- 在函数和控制语句之间应该使用适当的空行进行分隔,提高可读性。
10. 可移植性:- 不要使用与平台相关的特性或者语法。
- 使用标准的数据类型和函数接口,避免使用非标准扩展。
- 避免使用与编译器相关的优化选项。
以上是一些常用的C语言代码规范,可以根据具体的项目需求进行适当调整。
c语言编程的书写规则C语言编程的书写规则主要遵循以下规范:1. 缩进和空格:缩进和空格的使用可以使代码更易读。
通常,运算符两侧、逗号之后、控制语句(如if、for、while等)前后应添加空格。
在函数和括号的开头和结尾,通常应有空行。
2. 命名规则:变量和函数名应简洁且有意义。
通常,变量名和函数名以小写字母开头,后续单词的首字母大写,如 `myVariable`。
3. 注释:注释应简洁明了,解释代码的作用或目的,而不是解释代码是如何工作的。
注释应放在代码的上方或旁边,与代码保持一定距离。
4. 函数:函数应该尽可能短小,只做一件事情。
函数应具有描述性的名称,参数列表应清晰,并应包含返回类型。
5. 大括号:在C语言中,大括号 `{}` 用于定义代码块。
每一个独立的语句块都应该使用大括号。
6. 控制结构:控制结构(如if-else、for、while等)应该清晰明了,控制语句应只包含必要的逻辑。
7. 类型定义:类型定义应清晰明了,如果有必要,可以使用typedef来定义新的类型名称。
8. 预处理器指令:预处理器指令(如include、define等)应放在源文件的顶部。
9. 避免魔法数字和字符串:魔法数字和字符串(硬编码的值)会使代码难以理解和维护。
如果需要在代码中使用特定的值,应将其定义为常量或宏。
10. 避免全局变量:全局变量会使代码难以理解和维护,并可能导致意外的副作用。
尽可能使用局部变量。
11. 错误处理:在可能失败的操作后,应检查错误并相应地处理它们。
以上只是一些基本的C语言编程规则,实际编写代码时可能还需要考虑更多因素,如代码的可读性、可维护性、性能等。
C语言代码规范作为一种广泛使用的编程语言,C语言拥有着强大的功能和广泛的应用领域。
为了编写出高质量、可读性强的代码,遵循一定的代码规范是非常重要的。
本文将介绍一些常见的C语言代码规范,旨在帮助程序员写出更加规范、易于维护的代码。
一、命名规范在编写C语言代码时,合理的命名规范可以让代码更加易读、易懂,便于他人理解和维护。
1. 变量名和函数名的命名应使用有意义的英文单词或单词组合,并采用驼峰命名法,即首字母小写,后续单词首字母大写。
例如:userName, calculateScore。
2. 宏定义和枚举常量的命名应全大写,并使用下划线分隔单词。
例如:MAX_SIZE, COLOR_GREEN。
3. 结构体和联合的命名应采用驼峰命名法,首字母大写。
例如:StudentInfo, UserInfo。
二、缩进和空格良好的缩进和适当的空格使用可以提高代码的可读性,减少错误的发生。
1. 使用4个空格进行缩进,避免使用制表符。
2. 函数和循环体内的代码块使用花括号{}包围,且左花括号与代码在同一行,右花括号独占一行。
3. 运算符之间、逗号之后应添加空格,如:a = b + c; for(int i = 0; i < n; i++)。
4. 逻辑语句和赋值语句建议每行只书写一个,以增加可读性。
三、注释规范良好的注释具有很大的意义,可以让他人更容易理解代码的功能和思路。
1. 使用注释对代码进行解释和补充说明,以便他人理解代码的功能。
2. 注释应写在需要解释的代码上方,使用//或/* */进行注释。
3. 函数和重要代码块前应添加注释,说明其功能和预期结果。
四、函数规范函数是程序的基本组织单位,采用规范的函数写法有助于提高程序的可维护性。
1. 函数应具有明确的功能和作用,函数名应符合命名规范,能准确反映函数的功能。
2. 函数的参数如果较多,建议分行书写,并使用逗号对齐。
3. 函数应有良好的结构,合理划分代码块,可读性强。
c 编程规范C 编程规范是用来规范 C 语言程序代码风格和编写规范的一系列准则。
遵循 C 编程规范可以提高代码的可读性、可维护性,减少错误和 bug 的发生。
以下是一些常见的 C 编程规范建议:1. 代码缩进:缩进应该使用相同数量的空格符或制表符,一般为 4 个空格或一个制表符。
缩进可以使代码结构更清晰,便于阅读。
2. 命名规范:变量、函数和常量的命名应该具有描述性,能够准确反映其用途和含义。
使用驼峰命名法或下划线命名法是常见的命名风格。
注意避免使用与 C 语言关键字相同的名称。
3. 注释规范:代码中应该包含必要的注释,用于解释代码的逻辑、实现细节和算法。
注释应该清晰明了,不要出现拼写错误或过多的冗余信息。
4. 函数长度:函数的长度应该适中,不要过长。
一般来说,一个函数应该只负责一个具体的功能,如果函数过长应该考虑分割成多个子函数。
5. 模块化设计:程序应该使用模块化的设计原则,将功能相似或相关的代码块组织成不同的模块或文件。
这样可以提高代码的可维护性和可重用性。
6. 错误处理:程序应该正确处理各种可能发生的错误和异常情况。
避免简单地使用错误代码或忽略错误,而是采取适当的错误处理措施,例如返回错误码或抛出异常。
7. 变量声明:变量应该在使用前先声明,并且尽量在被使用的代码块的起始处进行声明。
声明时应给予适当的初始值,以避免使用未初始化的变量。
8. 代码复用:避免重复的代码和冗余的逻辑。
可以通过编写可重用的函数、使用循环和条件语句等方式来提高代码的复用性和可读性。
9. 括号的使用:括号的使用是保证代码逻辑准确性的重要方式之一。
建议在 if、for、while、switch 等语句块的使用中,使用括号来明确代码块的范围,以避免出现逻辑错误。
10. 代码格式:代码应该有一致的格式,用以增加可读性。
应避免使用过长的代码行,一般建议每行代码长度不超过 80 个字符。
综上所述,C 编程规范是编写高质量、可维护代码的基本准则。
C语言编程规范与风格C语言是一种广泛使用的编程语言,它的编程规范与风格对于保证代码的可读性、可维护性和可扩展性至关重要。
本文将介绍一些关键的C语言编程规范与风格,并提供一些实践建议。
1. 代码缩进代码缩进是C语言中非常重要的一个方面,它可以使代码结构清晰,易于阅读。
推荐使用4个空格或者制表符来进行代码缩进。
2. 命名规范为了让代码更易读和理解,命名规范应具有一定的规则性和描述性。
变量、函数和常量的命名应具有一定的规范,比如使用驼峰命名法(camelCase)或者下划线法(underscore_case)。
3. 注释注释是代码中的重要组成部分,可以使代码更易读和理解。
应该在代码中适当地使用注释,解释代码的功能、用途和注意事项。
注释应该清晰、简洁且易于理解。
4. 函数设计函数是C语言中重要的组织单元,应该遵循一定的设计原则来编写函数。
函数应该具有良好的命名,功能单一且高内聚。
函数的参数应该明确且合理,避免过多的参数传递。
函数的返回值应该清晰地说明其含义。
5. 条件语句和循环语句条件语句和循环语句是C语言中常用的流程控制语句,应该遵循一定的格式和风格。
条件语句的括号应该与关键字紧挨着,条件表达式应该适当地加上括号,以增加代码的可读性。
循环语句的条件表达式应该明确且易于理解,循环体应该具有合适的缩进。
6. 数据类型和变量声明在C语言中,数据类型和变量声明是非常重要的。
应该根据需要选择合适的数据类型,尽量避免使用过长或过短的数据类型。
变量声明应该在函数开头或者合适的位置进行,尽量避免使用全局变量。
7. 引入头文件C语言中的头文件对代码的模块化和可维护性非常重要。
在代码中应该适当引入所需要的头文件,避免使用过多的全局引入。
头文件应该具有合适的宏定义和条件编译,以提高代码的可复用性。
8. 错误处理在编程过程中,错误处理是非常重要的一部分。
应该养成检查错误和处理错误的习惯,合理运用条件语句和错误码,以便更好地调试和修复代码。
一〕=====[ 排版]¹1-1:程序块要采用缩进风格编写,缩进的空格数为4个说明:对于由开发工具自动生成的代码可以有不一致。
¹1-2:相对独立的程序块之间、变量说明之后必须加空行示例:如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;¹1-3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读示例:perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied= stat_poi[index].occupied;act_task_table[taskno].duration_true_or_false= SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)&& (n7stat_stat_item_valid (stat_item))&& (act_task_table[taskno].result_data != 0));¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首示例:if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}&& (j < NewKeyword.word_length); i++, j++){... // program code}for (i = 0, j = 0;(i < first_word_length) && (j < second_word_length);i++, j++){... // program code}¹1-5:若函数或过程中的参数较长,则要进行适当的划分示例:n7stat_str_compare((BYTE *) & stat_object,(BYTE *) & (act_task_table[taskno].stat_object),sizeof (_STAT_OBJECT));n7stat_flash_act_duration( stat_item, frame_id *STAT_TASK_CHECK_NUMBER+ index, stat_object );¹1-6:不允许把多个短语句写在一行中,即一行只写一条语句示例:如下例子不符合规范。
c语言编程规范C语言是一种广泛使用的编程语言,为了使代码可读性强,易于维护,编写出高质量的C语言代码,需要遵守一些编程规范。
1. 命名规范:- 使用有意义的变量和函数名称,避免使用缩写或不明确的名称。
- 变量和函数名称使用小驼峰式命名,以单词首字母小写,后续的单词首字母大写。
- 宏常量使用全部大写字母,并用下划线分隔单词。
2. 注释规范:- 使用注释来解释代码的逻辑、功能或者算法,提高代码的可读性。
- 在函数开头可以用注释来描述函数的输入、输出及功能。
- 注释应该与代码对齐,避免过长或过短,同时避免注释代码。
3. 缩进和空格规范:- 使用合适的缩进,增加代码的可读性。
- 使用4个空格作为一次缩进,而不是使用Tab字符。
- 在运算符和逗号后加一个空格,使代码更易读。
- 在大括号前加一个空格,与控制流语句对齐。
4. 代码结构规范:- 将相关功能的代码块放在一起,便于阅读和维护。
- 逻辑层次清晰,函数和类方法要尽量短小,每个函数的功能单一、复用性强。
- 相关联的变量放在一起声明,并按照类型顺序排序。
- 避免过长的行,推荐每行代码不超过80个字符。
5. 错误处理规范:- 在代码中检查错误并进行适当的处理,避免代码崩溃或者产生不可预料的结果。
- 使用错误码或者异常来处理错误,避免使用魔法数字。
- 使用合适的方式记录错误信息,方便调试和定位问题。
6. 动态内存管理规范:- 在使用动态内存分配时,需要及时释放分配的资源,避免内存泄漏。
- 需要注意避免指针悬挂和使用已经释放的内存。
7. 注重效率和安全性:- 在编写代码时注重代码的性能和效率,避免使用低效的算法。
- 在处理用户输入或者系统API调用时,需要对输入进行有效性检查,避免安全漏洞。
8. 一致性和规范性:- 保持代码的一致性和规范性,遵循编程规范,方便团队协作和代码维护。
- 遵循公司或项目的编码规范,保持团队的代码风格一致。
以上是C语言编程规范的一些基本要点,通过遵守这些规范,可以提高代码的可读性、可维护性和代码质量,使得代码更加规范和高效。
前言:一个好的程序编写规范是编写高质量程序的保证。
清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试效率,从而最终保证软件的质量和可维护性。
说明:本规范适用于公司内使用C语言编码的所有软件。
本规范自发布之日起生效,以后新编写的和修改的代码应遵守本规范。
注:使用固件和操作系统源代码应保留其代码风格目录1.排版与格式 (3)2.标识符命名与定义 (4)3.注释书写规范 (6)1.排版与格式规则1:程序块采用缩进风格编写,每级缩进为4个空格。
程序块采用缩进风格编写,每级缩进为4个空格,不使用TAB键,以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。
规则2:相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if (!valid_ni(ni)){// program code...}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应如下书写if (!valid_ni(ni)){// program code...}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;规则3:一条语句不能过长,如不能拆分需要分行写换行时有如下建议:• 换行时要增加一级缩进,使代码可读性更好;• 低优先级操作符处划分新行;换行时操作符应该也放下来,放在新• 换行时建议一个完整的语句放在一行,不要根据字符数断行示例:if ((temp_flag_var == TEST_FLAG)&&(((temp_counter_var - TEST_COUNT_BEGIN) % TEST_COUNT_MODULE) >= TEST_COUNT_THRESHOLD)) {// process code}规则4: 多个短语句(包括赋值语句)不允许写在同一行内,即一行只写一条语句。
c语言编程规范C语言编程规范(1000字)C语言作为一种广泛使用的编程语言,编写程序时应遵循一定的编程规范。
编程规范可以提高代码的可读性和维护性,减少错误和调试时间。
以下是一些常用的C语言编程规范。
1. 缩进和格式化:使用四个空格进行缩进,并在语句的开头和结尾留出适当的空格。
用大括号将代码块括起来,并将其包含的代码缩进四个空格。
例如:```cif (condition) {statement;}```2. 注释:对重要的代码块和函数进行注释,以便于其他开发人员阅读和理解代码。
注释应明确和简洁,并用英文书写。
例如:```c/* This function calculates the sum of two numbers */int sum(int a, int b) {return a + b;}```3. 命名规范:变量、函数和常量的命名应具有描述性,并使用小写字母和下划线分隔单词。
使用有意义的名称可以提高代码的可读性。
例如:```cint count; // 变量名用名词void print_hello(); // 函数名用动词const int MAX_LENGTH = 100; // 常量名全大写```4. 常量和宏定义:使用宏定义来定义常量和预处理指令,以便于代码维护和修改。
使用大写字母和下划线命名常量,并用宏定义来定义它们。
例如:```c#define MAX_LENGTH 100```5. 函数长度和复杂度:函数的长度应该控制在一定范围内,以提高代码的可读性和维护性。
通常推荐一个函数不超过30行代码,并且应该尽量避免过于复杂的控制流程。
如果一个函数超过了这个范围,可以考虑将其拆分为多个较小的函数。
6. 变量的声明和初始化:变量应在使用之前进行声明,并在声明时进行初始化。
声明时可以将相同类型的变量放在一起,并且可以将变量的声明放在函数体的开头。
例如:```cint main() {int foo, bar; // 变量声明int i = 0; // 变量声明和初始化...}```7. 错误处理:在编写代码时应该考虑错误处理。
C语言软件编写规范
以下是为大家整理的c语言软件编写规范的相关范文,本文关键词为语言,软件,编写,规范,北京,森馥,科技,股份有限公司,前言,您可以从右上方搜索框检索更多相关文章,如果您觉得有用,请继续关注我们并推荐给您的好友,您可以在教育文库中查看更多范文。
北京森馥科技股份有限公司
前言:
一个好的程序编写规范是编写高质量程序的保证。
清晰、规范的源程序不仅仅是方便阅读,更重要的是能够便于检查错误,提高调试
效率,从而最终保证软件的质量和可维护性。
说明:
本规范适用于公司内使用c语言编码的所有软件。
本规范自发布之日起生效,以后新编写的和修改的代码应遵守本规范。
注:使用固件和操作系统源代码应保留其代码风格
1
北京森馥科技股份有限公司
目录
1.排版与格式................................................................................................................. ....................................32.标识符命名与定义................................................................................................................. ........................43.注释书写规范................................................................................................................. .. (6)
2
北京森馥科技股份有限公司
1.排版与格式
规则1:程序块采用缩进风格编写,每级缩进为4个空格。
程序块采用缩进风格编写,每级缩进为4个空格,不使用TAb键,
以免用不同的编辑器阅读程序时,因TAb键所设置的空格数目不同而造成程序布局不整齐。
规则2:相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if(!valid_ni(ni)){
//programcode...}
repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;应如下书写
if(!valid_ni(ni)){
//programcode...}
repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni;
规则3:一条语句不能过长,如不能拆分需要分行写
换行时有如下建议:
??换行时要增加一级缩进,使代码可读性更好;
???低优先级操作符处划分新行;换行时操作符应该也放下来,放在新???换行时建议一个完整的语句放在一行,不要根据字符数断行示例:
if((temp_flag_var==TesT_FLAg)
intb=10;//不好的排版较好的排版inta=5;intb=10;
规则5:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括
号{}。
3
北京森馥科技股份有限公司
例:
if(value func(value);
}
规则6:在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
(1)比较操作符,赋值操作符\、\,算术操作符\、\,逻辑操作符\、\,位域操作符\、\等双目操作符的前后加空格。
if(current_time>=mAx_TIme_VALue)a=b+c;a*=2;a=b^2;
(2)\、\、\、\、\(地址运算符)等单目操作符前后不加空格。
*p='a';//内容操作\与内容之间flag=!isempty;//非操作\与内容之间p=//地址操作\与内容之间i++;//\与内容之间(3)\、\前后不加空格。
p->id=pid;//\指针前后不加空格
(4)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
if(a>=b&&c>d)
规则7:尽量使用宏定义代替数字
2.标识符命名与定义
标识符的命名要清晰、明了,有明确含义,同时使用完整的单词
或大家基本可以理解的缩写,避免使人产生误解
规则1:常量命名
常量命名的基本原则:
??符号常量的命名用大写字母表示。
如:#defineLengTh10
??如果符号常量由多个单词构成,两个不同的单词之间可以用下划线连接。
如:#definemAx_Len50
规则2:变量命名
变量命名的基本原则:
1)多个单词组成的变量名,首字母应该大写。
如:userInputValue。
2)用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。
3)变量名前加前缀,具体规则如下:
4
北京森馥科技股份有限公司
变量类型charunsignedcharshortunsignedshortintunsignedintfloatdouble全局静态结构体前缀s08_u08_s16_u16_s32_u32_f32_f64_g_s_strc_示例1:全局的char型变量g_u08_num
全局的结构体变量:g_strc_studentInfo
示例2:一些常见可以缩写的例子argument可缩写为argbuffer 可缩写为buffclock可缩写为clkcommand可缩写为cmdcompare可缩写为cmp
configuration可缩写为cfgdevice可缩写为deverror可缩写为err hexadecimal可缩写为hexincrement可缩写为inc、initialize可缩写为initmaximum可缩写为maxmessage可缩写为msgminimum可缩写为minparameter可缩写为paraprevious可缩写为prevregister可缩写为regsemaphore可缩写为semstatistic可缩写为statsynchronize可缩写为synctemp可缩写为tmp
示例3:一些常见的互斥意义单词
add/removebegin/endcreate/destroyinsert/deletefirst/lastget/releaseinc rement/decrementput/getadd/deletelock/unlockopen/closemin/maxold /newstart/stop
5
北京森馥科技股份有限公司
next/previoussource/targetshow/hidesend/receivesource/destinationcu t/pasteup/down
规则3:函数命名
函数命名原则与变量命名原则基本相同。
函数命名采用“Functionname”的形式。
3.注释书写规范
注释必须做到清晰,准确地描述内容。
对于程序中复杂的部分必须有注释加以说明。
注释量要适中,过多或过少都易导致阅读困难。
规则1:文件头的注释
/**********************************************************
**copyright(c),1988-1999,safetyTech.co.,Ltd.Filename:test.cpp Author:Version:Date:Description://模块描述Version://版本信息
FunctionList://主要函数及其功能1.-------
history://历史修改记录
David96/10/121.0buildthismoudle
***********************************************************
/
规则2:函数头的注释
/**********************************函数名称:bsp_Init
*描述:时钟初始化、硬件初始化*输入:无*输出:无
***********************************/
规则3:正文的注释
??如果变量的名字不能完全说明其用途,应该使用注释加以说明。
??数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。
对结构中的每个域的注释放在此域的右方。
??如果程序中使用了某个复杂的算法,建议注明其出处。
6
最后,小编希望文章对您有所帮助,如果有不周到的地方请多谅解,更多相关的文章正在创作中,希望您定期关注。
谢谢支持!。