变量及函数命名规范
- 格式:xls
- 大小:24.50 KB
- 文档页数:4
python中变量命名时的规则Python中变量命名的规则在Python编程中,变量是存储数据的容器。
为了方便理解和维护代码,我们需要遵守一定的变量命名规则。
本文将介绍Python中变量命名的规则,帮助读者编写规范、易读的代码。
1. 变量名由字母、数字和下划线组成。
变量名可以以字母或下划线开头,但不能以数字开头。
例如,age、_name、count1都是合法的变量名。
2. 变量名区分大小写。
Python是区分大小写的编程语言,因此变量名中的大小写字母被视为不同的变量。
例如,Name和name是两个不同的变量。
3. 变量名不能使用Python的关键字。
Python中有一些保留的关键字,用于表示特定的语法和功能。
这些关键字不能用作变量名。
例如,if、for、while是Python的关键字,不能用作变量名。
4. 变量名应具有描述性。
变量名应该能够清晰地描述它所代表的数据或对象。
这样可以增加代码的可读性和可维护性。
例如,name 比n更容易理解。
5. 变量名应使用下划线命名法或驼峰命名法。
下划线命名法将单词用下划线连接,例如first_name、last_name。
驼峰命名法将单词首字母大写,例如firstName、lastName。
选择哪种命名法取决于个人偏好和代码风格。
6. 变量名应避免使用单个字母。
单个字母的变量名通常难以理解,不具备描述性。
除非在循环或数学计算等特定情况下,应避免使用单个字母作为变量名。
7. 变量名应避免使用无意义的缩写。
虽然缩写可以节省一些字符,但会降低代码的可读性。
变量名应尽可能使用完整的单词或短语,以便其他人能够轻松理解代码的含义。
8. 变量名应遵循命名约定。
在Python社区中,有一些常见的命名约定被广泛使用。
例如,单个下划线开头的变量名通常用于表示私有变量,双下划线开头的变量名用于名称修饰。
遵循这些约定可以提高代码的一致性和可读性。
9. 变量名应尽量避免与内置函数或模块名冲突。
C语⾔命名规范⽰例⼀、命名约定——变量名(1)公共对象(变量)与公共函数(即具有全局性)应使⽤指⽰符作为前缀(即源代码⽂件)。
(2)所有对象均由字母、数字、下划线构成。
若是⽂件内部对象,只能采⽤⼩写字母。
若是全局对象(即外部链接)应加前缀。
(3)所有⽂件范围对象应在源代码⽂件中声明。
所有全局范围的对象应在头⽂件中声明。
定义类型适⽤的最⼩可能范围。
(4)对不同的或冗余⽂件将使⽤由下划线与单个字母组成的后缀(eg:tim_get_time_A.c,tim_get_time_B.c)。
(5)函数参数列表名称:函数内部的变量名应被维持⾄函数边界。
⼆、命名约定——函数名(1)函数名由字母、数字、下划线构成,尽量使⽤由单个动词和单个名词组成的名字。
(2)⾯向对象的相关函数应含有动词,后跟下划线与object_name(对象名)。
(3)函数名前缀”is”或”is_”应保留个布尔型函数以专门返回boolean_t等布尔型。
例如:isflower()。
三、命名约定——常量名(1)声明(即单独⼀⾏⽆参数申明#define),利⽤类型限定如const的对象与枚举量将被指为常量。
(2)整型、字符型与浮点型常量命令,⽆论其使⽤范围,均可由下划线与字母构成:⼤写字母与数字,⼩写字母与数字并以”_k”为后缀。
(3)后缀”_k”被保留⽤于整型、字符型与浮点型常量命名(4)使⽤符号量代替⽂字提⾼代码的可读性与维护性例如:If(speed_value=234)可重写为:static const uint16 speed_max_k=234;If(speed_value=speed_max_k);(5)枚举常量应由⼤写字母与下划线字符构成例如:typedef enum {BLACK,RED,GREEN} font_color_t;四、命名约定——宏名五、命名约定——类型别名类型别名的命名应由⼩写字母与下划线构成。
所有的类名应具有后缀”_t”(⾮union型)与”_u”(union型)。
1、严格采用阶梯层次组织程序代码:各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。
要求相匹配的大括号在同一列,对继行则要求再缩进4格。
例如:2、提示信息字符串的位置在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。
3、对变量的定义,尽量位于函数的开始位置。
二、命名规则:1、变量名的命名规则①、变量的命名规则要求用“匈牙利法则”。
即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。
即:变量名=变量类型+变量的英文意思(或缩写)对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。
见下表:bool(BOOL) 用b开头bIsParentbyte(BYTE) 用by开头byFlagshort(int) 用n开头nStepCountlong(LONG) 用l开头lSumchar(CHAR) 用c开头cCountfloat(FLOAT) 用f开头fAvgdouble(DOUBLE) 用d开头dDetavoid(VOID) 用v开头vVariantunsigned int(WORD)用w开头wCountunsigned long(DWORD) 用dw开头dwBroadHANDLE(HINSTANCE)用h开头hHandleDWORD 用dw开头dwWordLPCSTR(LPCTSTR) 用str开头strString用0结尾的字符串用sz开头szFileName对未给出的变量类型要求提出并给出命名建议给技术委员会。
②、指针变量命名的基本原则为:对一重指针变量的基本原则为:“p”+变量类型前缀+命名如一个float*型应该表示为pfStat对多重指针变量的基本规则为:二重指针:三重指针:......③、全局变量用g_开头,如一个全局的长型变量定义为g_lFailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写)④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_Inst,即:变量名=s_+变量类型+变量的英文意思(或缩写)⑤、成员变量用m_开头,如一个长型成员变量定义为m_lCount;即:变量名=m_+变量类型+变量的英文意思(或缩写)⑥、对枚举类型(enum)中的变量,要求用枚举变量或其缩写做前缀。
c语言命名规范C语言命名规范是为了提高代码的可读性和维护性,使不同人员编写的代码在风格上保持一致。
以下是一些常见的C语言命名规范:1. 变量和函数名应使用有意义的描述性词汇,尽量使用英文单词或缩写,避免使用无意义的单词或缩写。
2. 变量名应使用小写字母,使用下划线作为单词之间的分隔符,例如:num_students。
3. 函数名应使用小写字母,每个单词的首字母大写,使用驼峰命名法,例如:calculateAverage。
4. 宏定义应使用大写字母,并用下划线分隔单词,例如:MAX_NUM。
5. 常量名应使用大写字母,并用下划线分隔单词,例如:PI。
6. 结构体名应使用大写字母开头,每个单词首字母大写,使用驼峰命名法,例如:StudentInfo。
7. 指针名应以“p_”开头,后面跟上指向的变量名,例如:p_student。
8. 数组名应采用单数形式,例如:student。
9. 枚举类型应使用大写字母命名,并用下划线分隔单词,例如:ColorType。
10. 文件名应全部小写,并用下划线分隔单词,例如:calculator.c。
11. 函数参数名应使用小写字母,使用下划线作为单词之间的分隔符,例如:num_students。
12. 类型定义名应使用大写字母开头,每个单词首字母大写,使用驼峰命名法,例如:StudentInfo。
13. 行内函数或变量的命名应使用小写字母,用下划线分隔单词,例如:get_average。
总之,C语言命名规范应尽量清晰、简洁和有意义。
使用规范的命名方法可以提高代码的可读性和可维护性,从而更好地理解和修改代码。
dl命名法规则DL命名法规则概述DL命名法是一种命名规范,用于标识和管理计算机程序中的变量、函数、文件等。
这种命名规范是由“驼峰式”和“下划线式”两种方式组成的,它可以使代码更加清晰易读,提高代码的可维护性和可读性。
驼峰式驼峰式是指将单词首字母大写,并将其余字母小写。
这种方式通常用于标识变量、函数等。
1. 变量命名变量名应该具有描述性,能够清晰地表达出变量所代表的含义。
在使用驼峰式命名变量时,应该遵循以下规则:(1)首字母小写;(2)每个单词的首字母大写;(3)不使用下划线。
例如:int studentId;string firstName;2. 函数命名函数名称应该描述其功能,并且应该以动词开头。
在使用驼峰式命名函数时,应该遵循以下规则:(1)首字母小写;(2)每个单词的首字母大写;(3)不使用下划线。
例如:void calculateTotalScore();string getStudentName();下划线式下划线式是指将单词之间用下划线连接起来。
这种方式通常用于标识文件名、目录名等。
1. 文件命名文件名应该具有描述性,能够清晰地表达出文件所代表的含义。
在使用下划线式命名文件时,应该遵循以下规则:(1)全部小写;(2)单词之间使用下划线连接。
例如:student_info.txtemployee_salary.xlsx2. 目录命名目录名称应该具有描述性,能够清晰地表达出目录所代表的含义。
在使用下划线式命名目录时,应该遵循以下规则:(1)全部小写;(2)单词之间使用下划线连接。
例如:student_records/employee_information/注意事项1. 避免使用数字和特殊字符变量、函数、文件和目录的名称中不应包含数字和特殊字符,这会使代码难以阅读和维护。
2. 避免过长的名称变量、函数、文件和目录的名称不应过长,否则会影响代码的可读性。
一般来说,名称长度不宜超过20个字符。
游戏开发行业代码编写规章制度手册第一章代码编写原则在游戏开发行业中,代码编写是一个关键的环节。
为了保证代码的质量和可维护性,制定以下规章制度。
1.1 变量和函数命名规范变量和函数的命名应具有描述性,并且能够清晰表达其用途和含义。
遵循以下规范:- 变量名采用小写字母,采用驼峰命名法。
例如:playerName- 函数名采用动词开头,采用驼峰命名法。
例如:getPlayerName()1.2 注释规范注释对于代码的可读性和维护性至关重要。
遵循以下规范:- 在代码中适当添加注释,解释代码的功能、目的和实现方式。
- 对于复杂的算法或逻辑,用注释进行解释,以便其他开发人员理解。
1.3 代码缩进和格式化代码的缩进和格式化对于代码的可读性非常重要。
遵循以下规范:- 使用统一的缩进风格,推荐使用四个空格进行缩进。
- 代码块使用大括号括起来,并且遵循换行的方式,使代码更加清晰易于理解。
第二章代码编写流程为了保证代码的质量和开发效率,制定以下代码编写流程。
2.1 需求分析在编写代码之前,首先进行需求分析,明确目标和功能要求。
这有助于准确定义代码的实现方式。
2.2 设计阶段根据需求分析的结果,进行代码设计。
包括模块划分、类的设计以及算法和数据结构的选择等。
2.3 编码实现在编码实现阶段,根据设计的结果进行代码编写。
严格遵守代码编写规范,确保代码的可读性和可维护性。
2.4 单元测试编写完代码后,进行单元测试,验证代码的正确性和稳定性。
及时修复出现的问题,并确保代码符合预期的功能。
2.5 代码审查进行代码审查,由其他开发人员对编写的代码进行评审。
通过审查可以发现潜在的问题,并提出改进建议。
2.6 文档撰写编写完代码后,撰写相关的文档,包括代码说明、使用手册等,以方便其他开发人员参考和使用。
第三章代码安全和维护3.1 代码备份为了防止代码丢失或意外情况发生,定期进行代码备份,并将备份存储在安全的地方,以便日后的维护和恢复。
c语言中函数名和变量名的命名规则
C语言作为一种广泛应用的计算机编程语言,在程序设计中有着重要的地位。
其中函数和变量是程序中的两个重要概念,而函数名和变量名
的命名规则又是程序设计中的基础。
函数名的命名规则
1. 函数名的命名应该具有代表性,能够清晰地表达函数的功能与作用。
2. 函数名应该全部由小写字母组成,单词之间用下划线分隔。
3. 函数名应该以单词动词开头,例如print_message()。
4. 函数名应该避免使用系统保留字,如system, exit等。
5. 函数名长度原则上不应超过30个字符,充分表达即可。
变量名的命名规则
1. 变量名的命名同样应该具有代表性,能够清晰地表达变量的意义。
2. 变量名应该全部由小写字母组成,单词之间用下划线分隔。
3. 变量名可以以字母或下划线开头,但是不允许以数字开头。
4. 变量名应该遵循驼峰命名法,即首字母小写而后面的每个单词的首
字母都大写,例如studentName。
5. 变量名长度原则上不应超过30个字符,充分表达即可。
总结
在C语言中,函数名和变量名的命名规则对于程序设计至关重要,一个良好的命名可以提高程序的可读性和可维护性。
因此在进行函数名和变量名的命名时,我们应该时刻遵循以上规则,养成良好的编程风格,最终得到一个高质量的、易于运行和修改的程序。
1、严格采用阶梯层次组织程序代码:各层次缩进的分格采用VC的缺省风格,即每层次缩进为4格,括号位于下一行。
要求相匹配的大括号在同一列,对继行则要求再缩进4格。
例如:2、提示信息字符串的位置在程序中需要给出的提示字符串,为了支持多种语言的开发,除了一些给调试用的临时信息外,其他所有的提示信息必须定义在资源中。
3、对变量的定义,尽量位于函数的开始位置。
二、命名规则:1、变量名的命名规则①、变量的命名规则要求用匈牙利法则”即开头字母用变量的类型,其余部分用变量的英文意思或其英文意思的缩写,尽量避免用中文的拼音,要求单词的第一个字母应大写。
即: 变量名=变量类型+变量的英文意思(或缩写)对非通用的变量,在定义时加入注释说明,变量定义尽量可能放在函数的开始处。
见下表:bool(BOOL)用b开头bIsParentbyte(BYTE)用by开头byFlagshort(i nt)用n开头n StepCo untIon g(LONG)用1开头lSumchar(CHAR)用c开头cCo untfloat(FLOAT)用f开头fAvgdouble(DOUBLE) 用d 开头dDetavoid(VOID)用v开头vVaria ntun sig ned int( WORD) 用w开头wCo untun sig ned Ion g(DWORD)用dw开头dwBroadHANDLE(HINSTANCE ) 用h开头hHa ndleDWORD用dw开头dwWordLPCSTR(LPCTSTR) 用str 开头strString用0结尾的字符串用sz开头szFileName对未给出的变量类型要求提出并给出命名建议给技术委员会。
②、指针变量命名的基本原则为:对一重指针变量的基本原则为:“ p”变量类型前缀+命名如一个float*型应该表示为pfStat对多重指针变量的基本规则为:二重指针:“ pp”变量类型前缀+命名三重指针:“ ppp”变量类型前缀+命名③、全局变量用g_开头,如一个全局的长型变量定义为g」FailCount,即:变量名=g_+变量类型+变量的英文意思(或缩写)④、静态变量用s_开头,如一个静态的指针变量定义为s_plPerv_ In st, 即: 变量名=s_+变量类型+变量的英文意思(或缩写)⑤、成员变量用m_开头,如一个长型成员变量定义为m」Count;即:变量名=m_+变量类型+变量的英文意思(或缩写)⑥、对枚举类型(enum )中的变量,要求用枚举变量或其缩写做前缀。
C语言标识符命名规则(变量名和函数名)C语言变量和函数命名规范2010年08月05日星期四20:18C语言变量和函数命名规范: 关于C语言变量和函数命名规范据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。
命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命据考察,没有一种命名规则可以让所有的程序员赞同,程序设计教科书一般都不指定命名规则。
命名规则对软件产品而言并不是“成败悠关”的事,我们不要化太多精力试图发明世界上最好的命名规则,而应当制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。
1.共性规则本节论述的共性规则是被大多数程序员采纳的,我们应当在遵循这些共性规则的前提下,再扩充特定的规则,如3.2节。
【规则1-1】标识符应当直观且可以拼读,可望文知意,不必进行“解码”。
标识符最好采用英文单词或其组合,便于记忆和阅读。
切忌使用汉语拼音来命名。
程序中的英文单词一般不会太复杂,用词应当准确。
例如不要把CurrentValue写成NowValue。
【规则1-2】标识符的长度应当符合“min-length && max-information”原则。
几十年前老ANSI C规定名字不准超过6个字符,现今的C++/C不再有此限制。
一般来说,长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪。
那么名字是否越长约好?不见得! 例如变量名maxval 就比maxValueUntilOverflow好用。
单字符的名字也是有用的,常见的如i,j,k,m,n,x,y,z等,它们通常可用作函数内的局部变量。
【规则1-3】命名规则尽量与所采用的操作系统或开发工具的风格保持一致。
例如Windows应用程序的标识符通常采用“大小写”混排的方式,如AddChild。
而Unix应用程序的标识符通常采用“小写加下划线”的方式,如add_child。