提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档
文章目录
- 前言
- 一、命名总则
- 二、文件的命名
- 三、函数的命名
- 四、类的命名
- 1.类名
- 2.属性名
- 3.方法名
- 五、变量的命名
- 1.本地变量
- 1.全局变量
- 六、键的命名
前言
命名是编码的艺术之一,如何让命名简短、清晰、唯一、高拓展是一门语言艺术
常见命名格式:大驼峰MyName,小驼峰myName,大写MY_NAME,小写my_name,私有_my_name,魔术_my_name_
一、命名总则
1、除大小驼峰外,完整语义之间应用下划线_分开
2、避免使用常用简单的单个单词,以避免命名冲突。如必须使用,可查询是否有库已满足需求
3、使用完整单词
4、长单词考虑使用通用且不会引起歧义的缩写,或更换单词,如无合适单词,则需要思考是否必要
5、使用英语,不得使用拼音或谐音
6、对于必须使用的生僻词、歧义词、缩写,需统一进行定义说明并本地注解,方便阅读
7、避免使用个人色彩浓重的词,如人名、地点
8、出现介词/定语时应考虑拆分。如必须使用,在不影响理解的情况,适当省略介词。
9、自定义的内部变量及函数以单下划线开头,并可通过slot私有化,如:全局变量_MYNAME
10、不得使用magic命名形式,即不得以双下划线作为起始、结束,错误示例:_init_
11、应避免父类和子类出现同名属性和方法,如必须应以双下划线开头,如:__name
12、当前作用域变量不得与全局或上级作用域的变量重名,避免造成困扰
13、命名仅由字母、下划线、数字组成,优先字母下划线
14、通用缩写遵循原始命名
如无法满足当前命名规则,需要思考分割是否合理、功能是否简单、概念是否抽象、含义是否独立解耦。尊重英语的百年发展,语言本身就是一门认知世界的艺术。
二、文件的命名
1、风格:小写
2、长度:不超过15个字符,推荐8-10个字符,1-2个单词
3、单词选用:名词
三、函数的命名
1、风格:小写
2、长度:不超过15个字符,推荐8-10个字符
3、单词选用:动词+名词
四、类的命名
1.类名
1、风格:大驼峰
2、长度:不超过10个字符,推荐4-8个字符
3、单词选用:名词
2.属性名
1、风格:小写
2、长度:不超过8个字符,推荐4-6个字符
3、单词选用:_名词(私有),名词(非私有)
3.方法名
1、风格:小写
2、长度:不超过15个字符,推荐8-10个字符
3、单词选用:_动词_名词(私有),动词_名词(非私有)
五、变量的命名
1.本地变量
1、风格:小写
2、长度:不超过15个字符,推荐8-10个字符
3、单词选用:_名词(私有/本地),名词(非私有/非本地)
1.全局变量
1、风格:大写
2、长度:不超过15个字符,推荐8-10个字符
3、单词选用:名词
六、键的命名
1、风格:小写
2、长度:不超过6个字符,推荐2-4个字符
3、单词选用:_名词(私有/本地),名词(非私有/非本地)